I generally avoid sections and subsections as it increases the complexity of the documentation process. The sub-page itself is an ordinary page and it looks like as it is shown in the image below. The structural command to use for a Doxygen page is as shown in the markdown file you can see in the above picture, the Doxygen output has added the sub-page “ Sub module Name” under the page “ Module Name” on the tree-view at the left-hand side and added a link to it on our page. 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. For information on how to generate a new layout file refer to Layout, Headers, Footers, Stylesheets.Since the variable name radius is obvious to the reader of the code, I did not add the description. We suggest generating a new layout file from DoxyPress and then merge your changes. If you have an existing layout file you will need to update the file and add the new sections. Files have been split into File List and File Source. Changes in the Layout File New XML tags have been added to the Layout File for Signals and Slots. You can edit the field by hand or use the arrow push button to access the pop up window with file and folder selectors. ![]() Tags with List Values All tags in a list value must be separated by a comma. Do not include the default stylesheet (doxypress.css) in the HTML STYLESHEETS tag. Stylesheets The tags for HTML STYLESHEET and HTML EXTRA STYLESHEET were merged. The following are specific tags you should verify. Once this has been completed review all of the tag values in your project. ![]() From the Tools Menu in the DoxyPressApp select "Convert Doxygen project file to DoxyPress format". If you have an existing Doxygen configuration file you can easily convert to our JSON DoxyPress project file format. DoxyPressApp has a menu option to convert an existing Doxygen configuration file to a DoxyPress project file.
0 Comments
Leave a Reply. |