#Doxygen custom tags how to#
#Doxygen custom tags code#
#Doxygen custom tags free#

Second reference can be created to thorugh the page to link to the section. /// latex special_image.eps 'Special Image label' is often useful to divide a doxygen page into sections and subsections. So placing the image files in that location should allow Doxygen to find them. This is set by the IMAGE_PATH variable in the Doxygen file. Note that the image files must be placed in a location recognized by Doxygen.

#Doxygen custom tags how to#

Below I show how to insert images such that they appear in both html and pdfs generated by latex. Doxygen requires different image formats for the different output types. This tag allows one to insert an image into the documentation. /// picture is sometimes worth a thousand words or so the addage goes at least. So following on from the command above if I wanted to insert a link to the page describing James' awesome mode I would type Sometimes it works as described above, but other times it fails to replace 'word' with the 'string' for links from other command tells Doxgyen to insert a link to the specified page in this section. Note that I have had trouble including upper case letters in the 'word' naming the page.

Generally in html as least links are shown in blue. So in the above case Doxygen would replace 'describing_awesome_mode_by_james' with 'This Page describes James' Awesome Mode' in the generated documentation. Doxygen will replace any references to the page with the string that appears after the word. The first word after is the word that will need to be type in a command to link the page.

#Doxygen custom tags free#

Common Doxygen Page tag tells Doxygen that this is a free floating page and allows doxygen to name the page so that otehr pages can reference and link to the describing_awesome_mode_by_james This Page describes James' Awesome Mode

#Doxygen custom tags code#

This way you can tell people how to use your code directly in the file with your class tag allows you to describe what the function is returning. Also provide any information other programmers may find useful for using the tag allows you to insert code snippets which are then collected on the examples page. This block should explain the purpose of the class, the design considerations, and relation to other classes. You can specify the nature of the param as input output or both in the following tag informs doxygen that the comment block should be associated with the class. These are placed with the definition of the tag can be used to document the purpose and meaning of params for functions. By convention in Rosetta3 all functions must have details tags. what must be true for the function to work), how the function carries out it function, and what will be true when the function returns.

This message should give a user an idea of when it is valid to call this function( i.e. These included in the header file along with the declaration of the tag supplies a more detailed description. By convention in Rosetta3 all functions must have brief tags. This message should tell what happens in the function. Common Doxygen Tags Common Source Document tag supplies a brief description of a function for doxygen pages. To end the comment block type asterik and then forward slash.īy taking a few minutes as you are writing your code to write comment blocks you can tell future developers what you intended and make their life more productive and easier. To start a new paragraph add an empty line

These next few lines will form a comment block ///This line will be included in the Doxygen comments for this function/class/fileĬommenting multiple lines is just as easy. For line comment just insert a triple forward slash.

Template Doxygen Page for Documenting an Applicationĭoxygen comment blocks are easy to create.

Template page for Subdirectories of Libraries.

Template Doxygen Page for New Category of Source Files.

Each of the below template pages are found in doc/template_doxygen_pages. On the simplest level you can copy them to an appropriate location and fill in the fields with the appropriate information. These pages are intended as starting points.

Writing Descriptive Comments in DoxygenĪ few general template doxygen pages have been created to help you document higher level concepts in Rosetta.