How to generate Doxygen documentation pages

Table of Contents

• Description
  • First sub section
• Theory
• Implementation
• Results

Author

Feel++ Consortium

Date

2013-05-06

In this section we present some useful commands to edit new pages. You can create cross references using Layout .

Use section / subsection commands to structure your page. The following template is prefered

Description

This is our first section. You can eventually describe here the physical problem.

First sub section

Theory

Explain mathematical theory / variational formulation. You can use Latex formulas style. There are some syntax example :

Inline formulas \( \delta=\int_\Omega 1 dx\) works and Latex keywords aswell :

\f{equation}
\left\{
\begin{aligned}
   -\Delta u & =  f & \text{on}\;\Omega \;, \\
            u & =  0 & \text{on}\;\partial\Omega \;,\\
\end{aligned}
\right.
\f}
where \f$u\in\Omega\f$ is the unknown "trial" function and \f$\Omega\f$ the domain.

results in :

\begin{equation} \left\{ \begin{aligned} -\Delta u & = f & \text{on}\;\Omega \;, \\ u & = 0 & \text{on}\;\partial\Omega \;,\\ \end{aligned} \right. \end{equation}

where \(u\in\Omega\) is the unknown "trial" function and \(\Omega\) the domain.

Implementation

There we present the Feel++ code using the following command :

\snippet example.cpp marker1

Where example.cpp contains following line :

/// [marker1]
int main(){
  int example = 0;
  return example;
}
/// [marker1]

which results in

int main(){
  int example = 0;
  return example;
}

Results

Present your results in this section. You can use html syntax to integrate figures. There is an example :

first mode	second mode	third mode
Three eigenmodes

Note that image files have to be in one of the following directory :

• "@FEELPP_HOME_DIR@/doc/manual/pngs/"
• "@CMAKE_CURRENT_SOURCE_DIR@/pngs/"
• "@FEELPP_HOME_DIR@/doc/figures/"