1 / 6

Doxygen

Basic remarks. Doxygen. Main Features. Documenting with Doxygen Formulas Input Attention points. Documenting with Doxygen. Brief description //! Text block Detailed description /*! * text block * text block */ . Example 1. //! This is a foo function. / *!

hammett-hurst
Download Presentation

Doxygen

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Basic remarks Doxygen

  2. Main Features • Documenting with Doxygen • Formulas Input • Attention points

  3. Documenting with Doxygen • Brief description //! Text block • Detailed description /*! * text block * text block */

  4. Example 1 //! This is a foofunction. /*! * This function is … * \paramparamOne This parameter is … * \paramparamTwo This parameter is … * \return Description of a return variable */ <type> foo(<type> paramOne, <type> paramTwo, etc…){…}

  5. Three ways to include formulas • In-text formulas: \f$ … \f$ • Unnumbered formulas on a separate line: \f[ …\f] • Equation array: \f{eqnarray*}{ x &=& a \\ y &=& b \\ z &=& c \\ \f}

  6. Attention Points • Do not forget to run Doxygen at least once before submitting your code. • Update the parameters list for the functions regularly. • Update filenames if there has been any changes. • Doxygen is not Latex! Check whether the formulas are represented correctly by it.

More Related