Docu-Parts Generator for Doxygen
Doxygen is a tool for writing software reference documentation. The reference-comments are written within code, and are relatively easy to keep up to date. Doxygen can cross reference documentation and code, so that the reader of a document can easily refer to the actual code.
Docu-Parts Generator for Doxygen (DPG) help you to automatically regenerate graphics like Flowcharts, Call-Hierarchy and Type-Graphs. Scripts may be generated with DA-C Documentation Wizard, like in DA-C Automated Documentation generator (ADG). It's very simple, for example you choose one Flowchart, configure him with collapse and expand nodes and choose "Documentation > Wizard" menu, then "Copy DXY Script" and paste it in the DXY Script File.
Here are the DPG goals:
- Simple configuration
- Repeatability of generating
- Reusability of scripts
Main DA-C window with Docu-Parts Generator for Doxygen, click on picture to show enlarged version.
Script file example.dxy
// Flowchart for one function, shows also expanded nodes
[HardwareInit.jpg]
Job = GetFlowChart
Symbol = HardwareInit
File = Control\HrdwInit.c
Options = "B817ES3128112fV#B6$E2$O2#A$O6$OH$E8$O31$O6$OH$E1$O29$O5$OS"
// Default Non-Structured Flowchart for all function that did not have "own" script
[FCGN_%TargetSymbol.jpg]
Job = GetFlowChart
Symbol = %TargetSymbol
File = %TargetFile
Options = "B217ES31281114V#B6"
Doxygen comment block with graphics definitions
/*! Here is a snapshot of my new application:
* \image html HardwareInit.jpg
* \image html Jasminka.jpg
* \image html
*/
Main Browser window with Doxygen generated HTML site, click on picture to show enlarged version.