DOXYGEN Course

Other tags

Go back

These can be used almost everywhere, but you don't see them often

  • \deprecated why: if deprecated and why
  • \bug desc: if bug found and a description
  • \note desc: if you want to write a note with a description

Test-related tags

An invariant is something (variable, property, ...) whose value after the call of a function, is the same as it was before the call.

A precondition is something that we are taking for true.

And a postcondition is something that we ensure to make it true after the call of the function.

  • \test description: a test that may be done
  • \pre description: preconditions
  • \post description: post conditions
  • \invariant description: invariant