doxygen
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| doxygen [2018/05/02 20:25] – jeferson | doxygen [2018/06/25 19:22] (current) – jeferson | ||
|---|---|---|---|
| Line 17: | Line 17: | ||
| 1. C-style comment block | 1. C-style comment block | ||
| - | < | + | < |
| + | /** | ||
| * ... text ... | * ... text ... | ||
| */ | */ | ||
| Line 24: | Line 25: | ||
| 2. Qt style | 2. Qt style | ||
| - | < | + | < |
| + | /*! | ||
| * ... text ... | * ... text ... | ||
| */ | */ | ||
| Line 31: | Line 33: | ||
| 3. C++-like comment lines | 3. C++-like comment lines | ||
| - | < | + | < |
| + | /// | ||
| /// ... text ... | /// ... text ... | ||
| /// | /// | ||
| Line 38: | Line 41: | ||
| or | or | ||
| - | < | + | < |
| + | //! | ||
| //!... text ... | //!... text ... | ||
| //! | //! | ||
| Line 47: | Line 51: | ||
| 1. | 1. | ||
| - | < | + | < |
| + | /*! brief Brief description. | ||
| | | ||
| * | * | ||
| Line 56: | Line 61: | ||
| 2. | 2. | ||
| - | < | + | < |
| + | /// Brief description which ends at this dot. Details follow | ||
| /// here. | /// here. | ||
| </ | </ | ||
| Line 62: | Line 68: | ||
| 3. | 3. | ||
| - | < | + | < |
| + | /// Brief description. | ||
| /** Detailed description. */ | /** Detailed description. */ | ||
| </ | </ | ||
| Line 68: | Line 75: | ||
| or | or | ||
| - | < | + | < |
| + | //! Brief description. | ||
| //! Detailed description | //! Detailed description | ||
| //! starts here. | //! starts here. | ||
| </ | </ | ||
| + | |||
| + | ==== Creating the documentation: | ||
| + | |||
| + | The documentation can be created by many ways with doxygen. The most general is setting a Doxyfile, i. e., a file which describes the settings to be used by the doxygen documentation system. It can be done by accessing the program repository and typing the command | ||
| + | |||
| + | < | ||
| + | doxygen -g Doxyfile | ||
| + | </ | ||
| + | |||
| + | A standard Doxyfile is created and can be personalized with many options. | ||
| + | |||
| + | To create the documentation file run | ||
| + | |||
| + | < | ||
| + | doxygen Doxyfile | ||
| + | </ | ||
| + | |||
| + | If GENERATE_HTML is set to YES, doxygen will generate HTML output. Then open the index.html file to view the code documentation. For more information about doxygen and personalization issues click [[http:// | ||
| + | |||
| + | You can download the current Doxyfile used by the research group {{: | ||
doxygen.1525292743.txt.gz · Last modified: by jeferson