Doxygen

From Colettapedia
Jump to: navigation, search
  • structured text

documentation blocks

  • brief vs. detailed description (& body description = concatenation of all body comments)
    • brief is one-liner - can become tooltip
    • detailed description block marked by an extra * in /**, OR triple forwardslashes
  • Put brief or detailed descriptions for each member

Commands

  • \brief - command ends at the paragraph.
  • /// \param argname brief description
  • \return
  • Put brief or detailed descriptions for each member