Skip to content
Snippets Groups Projects
Commit f72f8a51 authored by Christian Engwer's avatar Christian Engwer
Browse files

Merge branch 'feature/restructure-doxgen' into 'master'

Feature/restructure doxgen



See merge request !25
parents 71e2e4b8 5438c22b
No related branches found
No related tags found
No related merge requests found
/**
@defgroup Common Common (foundation classes)
@defgroup Common Common
@brief foundation classes
*/
/**
......@@ -8,9 +9,43 @@
@ingroup Common
*/
/**
@defgroup Utilities Utilities
@brief Collection of helper classes, type traits, etc.
@ingroup Common
*/
/**
@defgroup Path Filesystem Paths
@brief Utilities for filesystem path management
@ingroup Utilities
*/
/**
@defgroup StringUtilities String Utilities
@brief Utility functions for std::string
@ingroup Utilities
*/
/**
@defgroup TupleUtilities Tuple Utilities
@brief Utility classes which can be used with std::tuple
@ingroup Utilities
*/
/**
@defgroup TypeUtilities Type Utilities
@brief Type traits, overload helpers, and other utilities for type computations
@ingroup Utilities
*/
/**
@defgroup Numbers Numbers
@brief Class implementing different number representations and helper functions
@ingroup Common
*/
/**
@defgroup FloatCmp FloatCmp
@ingroup Numbers
*/
......@@ -20,16 +20,16 @@
namespace Dune
{
/** @addtogroup Common
*
* @{
*/
#if HAVE_MPI
template<class K>
struct MPITraits;
#endif
/** @addtogroup Numbers
*
* @{
*/
namespace {
// numeric_limits_helper provides std::numeric_limits access to the internals
......
......@@ -8,8 +8,7 @@
*/
/**
@addtogroup FloatCmp FloatCmp
@ingroup Common
@addtogroup FloatCmp
@section How_to_compare How to compare floats
......
......@@ -10,13 +10,17 @@
#include <iostream>
#include <string>
#if HAVE_GMP
#if HAVE_GMP || DOXYGEN
#include <gmpxx.h>
namespace Dune
{
/**
* \ingroup Numbers
* \brief Number class for high precision floating point number using the GMP library mpf_class implementation
*/
template< unsigned int precision >
class GMPField
: public mpf_class
......
......@@ -7,8 +7,7 @@
namespace Dune {
/**
* @addtogroup Path Filesystem Paths
* @ingroup Common
* @addtogroup Path
* @{
*/
......
......@@ -22,11 +22,11 @@
namespace Dune {
/** @addtogroup Common
@{
*/
/**
* @addtogroup StringUtilities
*
* @{
*/
/** \brief Check whether a character container has a given prefix
*
......
......@@ -14,7 +14,7 @@
namespace Dune {
/** @ addtogroup Common
/** @addtogroup TupleUtilities
*
* @{
*/
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment