Menu
I don't really think the Doxygen HTML theme for documenting C code is good for documenting functions and procedures (though it is awesome for documenting OOP if using C++). So what I'm asking is can the output be changed to resemble the SDL Documentation or GTK Documentation?
965
Doxygen (/ˈdɒksidʒən/ DOK-see-jən) is a documentation generator and static analysis tool for software source trees. When used as a documentation generator, Doxygen extracts information from specially-formatted comments within the code.
Description. This is a command line tool that converts Doxygen generated XML files into markdown files (or JSON). You can use the generated Markdown files to create beautiful C++ documentation using with MkDocs, GitBook, VuePress, Hugo, Docsify, or any other static site generator that supports markdown.
Putting the command @brief will generate a short description of the function when you generate the doxygen documentation. That short description can be extended if you want. Follow this answer to receive notifications.
Doxygen allows you to set a few options that control the look of the output. generally they start with HTML_. For maximum flexibility, you can provide custom header and footer HTML, as well as a custom CSS stylesheet, via the HTML_HEADER, HTML_FOOTER and HTML_STYLESHEET options.
You can't do much to control the structure used in the main part of the page, but you can do a fair bit with the stylesheet, and as a last resort you can always add some javascript to the header that manipulates the DOM to rearrange things.
You can generate template header, footer and stylesheet files with the -w argument; and all this is documented reasonably well in the template config file generated with the -g argument.
152
The following theme allows the user to modify the color pattern, and the design is good.
https://github.com/kcwongjoe/doxygen_theme_flat_design
33
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
