mainpage.txt 809 Bytes
Newer Older
Bernd Flemisch's avatar
Bernd Flemisch committed
1
2
3
4
5
6
7
8
9
10
11
/*!
 * \file
 *
 * \brief documentation for the doxygen main page
 */

/** \mainpage DuMuX Documentation

\section intro Introduction

Welcome to the DuMuX documentation pages. This documentation has been
12
generated using <a href="http://www.doxygen.org/index.html">Doxygen</a>, a free source code documentation system for
Bernd Flemisch's avatar
Bernd Flemisch committed
13
14
15
16
documenting C/C++ code.

\section mods Modules

17
The best way to start is from the page <a href="modules.html">Modules</a> which gives
Bernd Flemisch's avatar
Bernd Flemisch committed
18
19
you access to the documentation by category.

20
21
22
23
\section params Parameters

An overview of all availabe parameters is given in \ref parameterlist.txt.

24
25
26
27
28
\section features Features

An overview of special features implemented in the Dumux-test-problems is given in \ref featurelist.txt.
<br>The list is currently in progress, it will be completed soon.

Bernd Flemisch's avatar
Bernd Flemisch committed
29
*/