![]() With these updates to the configuration file the output generated by Doxygen will be more refined.At this point we can begin development of our code but first, we are going to build a MainPage for our documentation that will provide anyone reading the documentation an overview and instructions on how to use the documentation.This will provide an overview of some useful tags which can be used when we document code. We can also exclude files and directories and specify filtering schemes that Doxygen should use on the inputs.īy default Doxygen does not generate a navigational frame.The navigational frame displays on the left hand side of the HTML page and allows us to navigate anywhere within our html document without having to jump through hoops in top menu.In order to display this framed navigation, under the HTML topic in DoxyWizard, the GENERATE_TREEVIEW option must be selected.įinally, the Dot topic allows us detailed control over our graphs.We can specify the dot font, control image format using DOT_IMAGE_FORMAT, specify directories, the look and the maximum number of nodes which can be generated within a graph. We can specify individual source directories, in addition to specifying file patterns such as *.c, setting an image directory and other options that the developer may find helpful. The Expert input topic has some very useful features which allow us to override our default inputs that were generated by the wizard. Therefore, we will always assume that the first line of a statement is a brief overview. This allows us to save time by not explicitly specifying brief command within our commands. The JAVADOC_AUTOBRIEF option under the project topic enables Doxygen to recognize the first line of a comment as the brief description. The wizard tab within DoxyWizard allowed us to quickly get Doxygen up and running.However, there are many customizable options which can be used that are only available from within the Expert tab.So before we begin talking in detail about how to work with our source files, we’ll first explore a few very useful options that are available to expert users. Jacob Beningo on Firmware Error Handling using Do while Loops.Akito on Firmware Error Handling using Do while Loops.Pieter Kruger on 4 Tactics to Unit Test RTOS Tasks. ![]() ![]() Bogdan Baudis on Are Multiple Languages Needed for Embedded Systems?.Jacob Beningo on 4 Tactics to Unit Test RTOS Tasks.
0 Comments
Leave a Reply. |
Details
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |