documentation openvibe

[matthieuG]

Hello,

The documentation explain how to build doc.dox-part and doc.dox-skeleton, but next steps are not clearly described. What and how to use Cmake to produce doxygen documentation?

Thanks

[lbonnet]

Hello MatthieuG,

The documentation is generated along with the applications when you run the build script. Everything ends in
/openvibe-documentation/. If you are running on Windows, we currently have some problems: CMake does not parse every subdirectory, thus the documentation is not generated correctly. But if you build on linux, you should have your documentation (html / latex) in the /openvibe-documentation/ directory.

I hope this helps !

Laurent-

[matthieuG]

so the good way is usually :
_create a dox-part in plugins\src\doc
_create a dox-skeleton in openvibe-documentation
-lunch the build script (win32- or linux-build)

But under windows, it doesn't process, does it!

The result of process should appear in openvibe-documentation?

[lbonnet]

_create a dox-part in plugins\src\doc
_create a dox-skeleton in openvibe-documentation

You don't even have to do it yourself ;)
run the openvibe-plugin-inspector, it will check all existing boxes, and create the xxxx.dox-part-skeleton and xxxx.dox-skeleton files for you. The 2 files will be in /openvibe-documentation. Copy-paste the xxxx.dox-part-skeleton file in openvibe-plugins/[path-to-your-plugin-branch]/src/doc, rename it to xxxx.dox-part and complete it.

then run the linux build script, and watch the result in /openvibe-documentation.

But under windows, it doesn't process, does it!

Indeed, it doesn't process under Windows.

Your question have made us think about our current documentation tutorial, which is incomplete. We will certainly update it to be more precise, and include the plugin-inspector usage.

Laurent-

- EDITED (Tue Dec 8) -

[matthieuG]

It would be a very good idea to generate documentation pattern with plugin-inspector. At present, it seems it doesn't.

[lbonnet]

I edited my last reply to be more precise.

It would be a very good idea to generate documentation pattern with plugin-inspector. At present, it seems it doesn't.

The plugin-inspector generates such pattern, it's the xxxx.dox-part-skeleton file. This file contains every tags such as :

Code: Select all

 * |OVP_DocBegin_BoxAlgorithm_XXXX_Input1|
 * |OVP_DocEnd_BoxAlgorithm_XXXX_Input1|

You just have to fill the file between these tags with your documentation, copy the file in your plugin folder and rename it xxxx.dox-part.

Hope this helps

Laurent