In a later section of this article, I have shown you how to enable “TreeView” which I think is better than the default view for C documentation. These will show in the first level of pages on your left-hand side of the tree view. This is the page shown when you click index.html from the HTML folder generated by Doxygen. This tag on one of our markdown files will tell the Doxygen parser that a given markdown file is the main page for the project. The Doxygen structural command to use is as shown in the example above. This is the main page for the project, you can enter the details like requirements, release notes, overall architecture, etc., in this page. This is how a project main page should be made in a markdown running it through Doxygen the final HTML file will look like this Let’s first look at an example of the main page and then we can look at the theory side of things.
Our markdown files as 3 hierarchical pages Understand what markdown files are I recommend you to watch this short youtube If you need to provide code snippets, coding standards, architecture information, etc, on your documentation then the best way to do it is via pages or markdown files. Doxygen pagesĪpart from syntaxes and tags mentioned above, Doxygen can also use markdown files to generate HTML webpages as part of your documentation. Please have a look at my other article When to use and when to avoid comments? for guidelines on commenting. Since the variable name radius is obvious to the reader of the code, I did not add the description.
0 kommentar(er)
