This section provides a quick cheat sheet of the Doxygen documentation style selected for this library.Ī brief comment block is marked with three slash characters ( ///). Settings that differ from the default are highlighted in red. Each setting is meticulously documented in the wizard and configuration file. An excellent cross-platform Doxygen GUI frontend called doxywizard is included with the Doxygen package to manage settings and generate output. ![]() The Doxygen configuration file ("Doxyfile") can be found in the doc subdirectory. Although harder to type, an (at) character was selected to mark special commands instead of the \ (backslash) character to make these commands more prominent. Below I show how to insert images such that they appear in both html and pdfs generated by latex. The JavaDoc comment style was selected for this library. Doxygen requires different image formats for the different output types. Files using specialised Doxygen syntax are indicated with a *.dox extension. Files with regular markdown syntax (as used by GitHub) are indicated with a *.md extension. var to document a variable or typedef or enum value. Other structural commands are: struct to document a C-struct. Markdown formatting is human readable and easy to grasp and has been included since Doxygen 1.8.0. Here the special command class is used to indicate that the comment block contains documentation for the class Test. The comments embedded in the source code must be formatted in a special way, which may decrease readability for users not familiar with the special syntax. Doxygen allows you to put your documentation blocks practically anywhere (the exception is inside the body of a function or inside a normal C style comment block). The default output directory is the directory. ![]() As the names suggest these directories contain the generated documentation in HTML, RTF, and Unix-Man page format. Doxygen will create a html, rtf, latex and/or man directory inside the output directory. Click here for the online Doxygen manual. To generate the documentation you can now enter: doxygen .Doxygen is a tool that generates documentation from source code.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |