HELP - ExampleInline
HelpExample CodeHowToDocumentExampleInline
Description Source Call Graph
HowToDocument::ExampleInline ( Public Method )
Author: N.F.S Grundtvig (The members of this class inherits the author by default.)
How to write an example (ie not including from file).
 
Syntax / parameters
void ExampleInline ()

Description
How to write an example (ie not including from file).
Use: \example \endexample.

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. In case you want to inline
formatted code directly in in the documentation refer to InlineFormattedCode.

This is how it looks in the source:
\example 
void exampleFunction()
{
  cout<<"This is an inlined example!\n";
}
\endexample

Notes
  • It's possible to make as many examples as possible.
  • Examples also works in page and directory documentation.
  • See also
  • ExampleInclude(), InlineFormattedCode().
  • Examples
    void exampleFunction()
    {
      cout<<"This is an inlined example!\n";
    }
    


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