Tag: doxygen

lzoDSO – Firmware Documentation

Posted by June 12, 2013

oscilloscopeMoved form using Doxygen 1.7.1 (comes with Debian 6) to Doxygen 1.8.4 (build from sources) for the lzoDSO firmware documentation. Looks much nicer.

Still, there is a problem with the documentation (unrelated to doxygen). All code that is linked to the project repository using svn:externals properties is somehow not covered (still investigating). I think this is somehow related to the way the Bitten slave (build slave of my CI setup) does the automated build (in which doxygen gets executed).

If you ever had something similar, please let me know (via comment or Twitter).

Using Doxygen

Posted by June 12, 2013

doxygenAfter using Doxygen for a couple of years, I have collected the basics of how to work with it in a short article in the labs wiki.

The article covers installation from package or sources and short list of doxygen parameters that are essential to building your documentation based on source file comments.

I thought it is about time to publish it, even though its quiet short.

lzoDSO – Documentation

Posted by May 27, 2013

oscilloscopeI have set up a routine that automates the generation of documentation for the prototype firmware on every commit to the repository.

The documentation is generated using Doxygen, which scans for comments in the source files and compiles into one structured document. The result is available here.