ElmerFoamFSI  2.0
ElmerFoamFSI is fluid-solid interaction simulation application built up from OpenFOAM CFD and Elmer CSM coupled through the IMPACT multiphysics software integration infrastructure.
 All Classes Namespaces Files Functions Variables Typedefs Enumerator Macros Groups Pages
std::string ExampleFunction ( const std::string &  instring)

Example function for ElmerFoamFSI (this is a brief description).

Parameters
instringInput string to copy
Returns
A copy of the input string
Bug:
No known bugs.
Note
All of this documentation is generated from the comments in ExampleHeader.H
The first sentence in a doxygen comment block before a code construct is interpreted as the "brief" description.
Warning
This is an example warning.
Todo:
Nothing to do on this example function.

The detailed description for ExampleFunction actually starts above with the constructs describing the input/output, and any notes, warnings, todo, bugs, author, or other information the author would like to put in.

At IR, we like for all code constructs to have a "brief" description -first sentence in this comment block, and then a "detailed" description as needed, but it should at least list the input params and output description. The actual example detailed documentation for this function now follows:

This function returns a copy of the input string. If there were more to say about this, then it can be said here.

Definition at line 31 of file src/ExampleSourceFile.C.

Referenced by TestingObject< ResultsType >::Test__ExampleFunction().

32  {
33  return(instring);
34  };

Here is the caller graph for this function: