![]() NB: The word Introduction above will appear as a link that will jump to the Introduction heading. > I've got this line in the configuration file: > USEMDFILEASMAINPAGE RE. > And some contextual info, just in case it can be useful: > Windows 7 > Visual Studio 2012 > C > Doxygen version is 1.8.9.1. This is some text in my body, where I refer to the Introduction. The message is > as follows: > README.md:1: warning: found more than one \mainpage comment block > Skipping this block. This is some text in my body, where I refer to the Intro. This is some text in my Body Body Paragraph ![]() The second parameter section title is a string of words (that can be separated by spaces) which defines what the section heading will appear as on your page. The first parameter section-name defines the reference name that can be used by the element. It is visually equivalent to a # element in Markdown, however it will also define a reference that can be linked to from other sections of your documentation. If not used, the link will appear as the title used in the reference. The second optional parameter ( "text") should be encapsulated in double quotes, and will define what the reference link will appear as on the page. The first parameter ( name) should match the name of the section, subsection, page or anchor that you wish to link to. reference) to a named section, subsection, page or anchor that has been defined elsewhere in the documentation. The primary features are the use of tags for references, and the and elements that these can reference. This command behaves similar as \ref in the sense that it creates a reference to a page labeled with the optional link text as specified in the second argument.In addition to the standard Markdown syntax, there are a number of Doxygen-specific elements. The main page (see \mainpage) is typically the root of hierarchy. Template Doxygen Page for New Category of Source Files Template page for Subdirectories of Libraries Template Doxygen Page for Documenting an Application Writing Descriptive Comments in Doxygen Doxygen comment blocks are easy to create. The same conventions listed above apply to lib/pkp as well.Īs the system makes use of inheritance and has consistent class naming conventions, it is generally easy to tell what category a particular class falls into.įor example, a Data Access Object class always inherits from the DAO class, has a Class name of the form DAO, and has a filename of the form is a commonly used code documentation tool (for languages including C , C# and Java) that also supports the use of Markdown. Each of the below template pages are found in doc/templatedoxygenpages.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |