HELP - IncludeDocFromBody
HelpExample CodeHowToDocumentIncludeDocFromBody
Description Source Call Graph
HowToDocument::IncludeDocFromBody ( Public Method )
Author: N.F.S Grundtvig (The members of this class inherits the author by default.)
Include documentation from function body.
 
Syntax / parameters
void IncludeDocFromBody()

Description
Include documentation from function body. Here we show how documentation can be included also from the body of a function. Please "click" on the "Source"-tab in your browser to view the code and see how this is done!

This is how it looks in the source:
void  HowToDocument::IncludeDocFromBody() 
{ // Here we don't need to put the ending parenthesis after 2.1f on a newline, 
  // since the statement doesn't end until the ending '}'
  float fFloat = iSize * 3 + fMAX2;
  /// !Inlined documentation from function body.
  /// You can add documentation from within the function body this way.
  /// It is just concatenated to the normal documentation block.\n
  /// This only works if you have set #HIDE_IN_BODY_DOCS# to #NO# in the config file (default).\n
  /// #}As of right now it does not work with \\note \\todo etc., but that's on our todo-list :-)#}
}


Inlined documentation from function body.
You can add documentation from within the function body this way. It is just concatenated to the normal documentation block.
This only works if you have set HIDE_IN_BODY_DOCS to NO in the config file (default).
As of right now it does not work with \note \todo etc., but that's on our todo-list :-)


 
Source
The documentation for this Member was generated from the following files:
  • HowtoDocument.cpp
  • HowtoDocument.h