Does cppcheck have any scripts for autogenerating it's documentation?

[john borland]

I was wondering if cppcheck has any scripts to help it auto generate it's documentation?

I would say when I run into most cppcheck users I often find out they have no idea about the library checks and the addons. I often have to write scripts to auto generate documentation for work. Maybe I could write a script to help pull data out of library files and the addons to help make it easier for users to stumble apon information about them.

[Daniel Marjamäki]

I am not sure what information you want to extract. I don't have a script that extract any information from the library files. for the misra addon we extract information about supported checks.

[john borland]

To me I would start with a list of the library files and what project they are associated with. But it is probably best to update the XML to add those fields like libraryName , libraryDescription, libraryVersion, and libraryLink.

avr.cfg -- avr 2.0 -- Standard C library for AVR-GCC
http://www.nongnu.org/avr-libc/user-manual/group__avr__stdint.html

bento4.cfg -- bento4 1.6.0-639 -- A fast, modern, open source C++ toolkit for all your MP4 and DASH/HLS/CMAF media format needs.
https://www.bento4.com/

boost.cfg -- boost 1.78.0 -- free peer-reviewed portable C++ source libraries.
https://www.boost.org/doc/libs/

bsd.cfg -- BSD -- Berkley Software Distribution

cairo.cfg -- Cario 1.17.4 -- Cairo Library Configuration
https://www.cairographics.org/

After that I would then make an appendix document that has the xml printed pretty in it so people can see if the functions they are using are actually in the config file.

To me the hard part when auto generating documentation is figure out the best way for people to precipitate. Cfg files are easier because they are just xml. Has a first cut on the addon's I would just make special symbols to gerp out of the files. For example ##@Description and ##@Check. This could allow for similar approach that the manual could have just the name, version, and description of the addons. With an appendix with more info for the checks.

In most cases I work with people who only uses the command line version of cppcheck. We could probably put links to the appendix documents in the cppcheck help menu.

That's what I was kind of thinking of.