Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Mihini/Mihini Generate Documentation"
< Mihini
| Line 32: | Line 32: | ||
There are 3 targets: | 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 [http://eclipse.org/koneki/ldt/ Koneki IDE] | |
| − | + | * doxygen_gen: C APIs documentation | |
Revision as of 11:11, 17 April 2013
1. Get the source
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: http://www.stack.nl/~dimitri/doxygen/download.html http://johnmacfarlane.net/pandoc/installing.html
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