HELP - Internal
HelpExample CodeHowToDocumentInternal
Description Source Call Graph
HowToDocument::Internal ( Public Method )
Author: N.F.S Grundtvig (The members of this class inherits the author by default.)
Making internal documentation.
 
Syntax / parameters
void Internal ()

Description
Making internal documentation.
This is done using the keyword: \internal.

Internal comments are intended for use by the developers of the code/library and not for the users of the library. You can use INTERNAL_DOCS in the config file to show or hide the internal documentation.

This is how it looks in the source:
\internal This is an internal comment.

About section commands
This command is a section command (also called special section). Common to all section commands is the fact that the section continues until a blank line or another section command is encountered.

The section commands are:
See also
  • Todo (\todo)
  • For internal use only.
  • This is an internal comment.
  •  
    Source
    The documentation for this Member was generated from the following files:
  • HowtoDocument.cpp
  • HowtoDocument.h