HELP - InlineFormattedCode
HelpExample CodeHowToDocumentInlineFormattedCode
Description Source Call Graph
HowToDocument::InlineFormattedCode ( Public Method )
Author: N.F.S Grundtvig (The members of this class inherits the author by default.)
How to inline formatted code in the documentation.
 
Syntax / parameters
void InlineFormattedCode()

Description
How to inline formatted code in the documentation.

Use: \code \endcode.

Inline formatted code in place
Examples are always put into the "example" section, which is at the end of the generated documentation page for the entity. When using \code \endcode statements you can inline code where you want.

For example like this:
void inlinedCode()
{
  cout<<"This is inlined code ie. not and example!\n";
  cout<<"Se also!\n";
  HowToDocument::ExampleInline();
  HowToDocument::ExampleInclude();
}


Then you can continue writing documentation here...

This is how it looks in the source:

\code
void inlinedCode()
{
  cout<<"This is inlined code ie. not and example!\n";
  cout<<"Se also!\n";
  HowToDocument::ExampleInline();
  HowToDocument::ExampleInclude();
}
\endcode


Notes
  • Use \pre \endpre to output raw un-formatted text, or the \verbatim \endverbatim, which is the commands used in the original Doxygen.
  • See also
  • ExampleInclude(), ExampleInline().
  •  
    Source
    The documentation for this Member was generated from the following files:
  • HowtoDocument.cpp
  • HowtoDocument.h