One really cool thing with Processor Expert is: it does not only generate the source code for me, it generates as well documentation :-). I’m a believer of the ‘single source’ approach: if I have to document a software project, then the software itself shall be the source of the documentation. And for this I love Doxygen: see “5 Best Eclipse Plugins: #1 (Eclox with Doxygen, Graphviz and Mscgen)“. Doxygen is a compiler which compiles my source files, and instead of object files it creates documentation files for me :-).
Processor Expert Documentation
With the latest Processor Expert releases, it creates by default documentation files which can be used by Doxygen:
To use it, I need Doxygen and Eclox (the Eclipse Doxygen plugin) installed. How to do this is described in “5 Best Eclipse Plugins: #1 (Eclox with Doxygen, Graphviz and Mscgen)“. Basically this means installing Doxygen plus the Eclox plugin into Eclipse.
Generating Documentation with Doxygen
The first time I generate documentation with Eclox/Doxygen, I need to choose the .doxyfile which has all the settings:
Then select the Doxygen configuration file and press OK:
This then kicks off the Doxygen compiler to generate the documentation:
This generates the documentation in their folders:
As you can see, it creates html, LaTeX and RTF documentation. This can be configured in the doxygen settings: double click on the .doxyfile to open the editor:
Opening the html/index.html file shows the root of the documentation, where I can get the memory map:
Or such as the pin muxing table:
Doxygen/Eclox is something I already use for a very long time. Processor Expert creates in the recent versions (e.g. Driver Suite 10.4 or later, or in Kinetis Design Studio) already Doxygen configuration files and extra information like Pin Allocation reports or Muxing tables which is very helpful. There are still some minor Doxygen glitches in the generated files which I’m going to report, but otherwise this is very useful to me already.
Happy Documenting 🙂