Difference between revisions of "Mihini/Mihini Generate Documentation"

From Eclipsepedia

Jump to: navigation, search
(New page: 1. Get the source ----------------- [http://git.eclipse.org/c/mihini Mihini Git repository] 2. Install prerequisites ------------------------ Install pandoc and doxygen on your dev ma...)
 
 
(2 intermediate revisions by one user not shown)
Line 11: Line 11:
 
usually it is as simple as using the package manager of your operating system.
 
usually it is as simple as using the package manager of your operating system.
 
Example:
 
Example:
{code}
+
 
 +
<source lang="bash">
 
sudo apt-get install pandoc doxygen
 
sudo apt-get install pandoc doxygen
{code}
+
</source>
  
 
More details on:
 
More details on:
http://www.stack.nl/~dimitri/doxygen/download.html
+
* http://www.stack.nl/~dimitri/doxygen/download.html
http://johnmacfarlane.net/pandoc/installing.html
+
* http://johnmacfarlane.net/pandoc/installing.html
  
 
3. Build the documentation
 
3. Build the documentation
 
--------------------------
 
--------------------------
  
Building the documentation is linked to Mihini build system, that is explained here:
+
Building the documentation is linked to Mihini build system, that is explained in [http://wiki.eclipse.org/Mihini/Mihini_Agent_Linux_build_instructions Mihini Linux build instructions]
  
{code}
+
<source lang="bash">
 
build.sh
 
build.sh
 
cd build.default
 
cd build.default
make mdoc doxygen_gen
+
make mdoc doxygen_gen luaExecEnv
{code}
+
</source>
  
 
There are 3 targets:
 
There are 3 targets:
- mdoc
+
* mdoc: Markdown documentation with agent internal documentation, specifications,etc
- luaExecEnv
+
* luaExecEnv: Lua APIs documentation in a "doxygen-like" form, it also generates a Lua Execution Environment file for [http://eclipse.org/koneki/ldt/ Koneki IDE]
- doxygen_gen
+
* doxygen_gen: C APIs documentation
  
  
 
4. Doc Artifacts
 
4. Doc Artifacts
 
----------------
 
----------------
 +
 
Everything is generated as html in:
 
Everything is generated as html in:
  
{code}
+
<source lang="bash">
build.default/doc/
+
 
build.default/doc/md
 
build.default/doc/md
 
build.default/doc/ldoc
 
build.default/doc/ldoc
 
build.default/doc/doxygen
 
build.default/doc/doxygen
{code}
+
</source>

Latest revision as of 11:16, 17 April 2013

1. Get the source


Mihini Git repository


2. Install prerequisites


Install pandoc and doxygen on your dev machine: usually it is as simple as using the package manager of your operating system. Example:

sudo apt-get install pandoc doxygen

More details on:

3. Build the documentation


Building the documentation is linked to Mihini build system, that is explained in Mihini Linux build instructions

build.sh
cd build.default
make mdoc doxygen_gen luaExecEnv

There are 3 targets:

  • mdoc: Markdown documentation with agent internal documentation, specifications,etc
  • luaExecEnv: Lua APIs documentation in a "doxygen-like" form, it also generates a Lua Execution Environment file for Koneki IDE
  • doxygen_gen: C APIs documentation


4. Doc Artifacts


Everything is generated as html in:

build.default/doc/md
build.default/doc/ldoc
build.default/doc/doxygen