charon-xml-helper — detect charon modules from doxygen xml files
charon-xml-helper
[DocXmlDir
] [ --ids
| --mod-index
| --xcheck
]
charon-xml-helper reads the xml files generated by doxygen. Checks all classes contained in the class index, if they subclass ParameteredObject. If called without arguments, charon-xml-helper gives a short option summary.
DocXmlDir
Directory where the doxygen xml documentation is located.
In this directory, there is a file named
index.xml
.
If there is no such file, the program terminates.
If no directory is specified, an option summary is printed.
--ids
Do not show the class names but the doxygen ids by the classes that are detected to be modules. This is useful for scripting to iterate over the doxygen files which use these ids as filename.
--mod-index
Generate modified class index xml file filtered by detected charon module classes. Simply drops all entries from index.xml wich do not meet this condition. The resulting xml file is printed on stdout.
--xcheck
Cross check group of charon modules and objects that inherit ParameteredObject. Prints out differences between list of potential module classes and charon-modules group content.
All items within the charon-modules group should be real modules, i.e. if items of that group are found that do not inherit ParameteredObject, something is wrong. Remove these items from the charon-modules group.
The other way round is ok, e.g. abstract base classes may inherit ParameteredObject and so are detected as module candidates but since they cannot be instanciated, they are no real modules.