HELP - ExceptionsThrown
HelpExample CodeHowToDocumentExceptionsThrown
Description Source Call Graph
HowToDocument::ExceptionsThrown ( Public Method )
Author: N.F.S Grundtvig (The members of this class inherits the author by default.)
Documenting exceptions thrown by a function.
 
Syntax / parameters
void ExceptionsThrown ()

Description
Documenting exceptions thrown by a function.
This is done using the keyword: \throw.

This is how it looks in the source:
\throw ExceptionName Description of exception that can be thrown.

Exceptions thrown
Name Description
ExceptionName
Description of exception that can be thrown.
Notes
  • To provide compatibility with original Doxygen the following aliases for the \throw command also works: \throws, \exception and \exceptions
  •  
    Source
    The documentation for this Member was generated from the following files:
  • HowtoDocument.cpp
  • HowtoDocument.h