From 7ed3fe69c09f06b0474eace74b7091e7ba8fd7fd Mon Sep 17 00:00:00 2001 From: Andreas Lauser Date: Mon, 15 Apr 2013 17:49:41 +0200 Subject: [PATCH] Fix a few doxygen issues with the tutorials --- tutorials/tutorial1.cpp | 9 ++++----- tutorials/tutorial2.cpp | 7 +++---- tutorials/tutorial3.cpp | 6 ++---- tutorials/tutorial4.cpp | 6 ++---- 4 files changed, 11 insertions(+), 17 deletions(-) diff --git a/tutorials/tutorial1.cpp b/tutorials/tutorial1.cpp index 9bd2a0ba..d4465a2c 100644 --- a/tutorials/tutorial1.cpp +++ b/tutorials/tutorial1.cpp @@ -1,5 +1,5 @@ +/// \cond SKIP /*! -\cond SKIP Copyright 2012 SINTEF ICT, Applied Mathematics. This file is part of the Open Porous Media project (OPM). @@ -16,11 +16,8 @@ You should have received a copy of the GNU General Public License along with OPM. If not, see . -\endcond */ -#if HAVE_CONFIG_H -#include "config.h" -#endif // HAVE_CONFIG_H +///\endcond /// \page tutorial1 A simple cartesian grid /// This tutorial explains how to construct a simple Cartesian grid, @@ -34,6 +31,8 @@ /// \snippet tutorial1.cpp including headers /// \internal [including headers] +#include "config.h" + #include #include #include diff --git a/tutorials/tutorial2.cpp b/tutorials/tutorial2.cpp index 88016a69..964660b6 100644 --- a/tutorials/tutorial2.cpp +++ b/tutorials/tutorial2.cpp @@ -1,5 +1,5 @@ +/// \cond SKIP /*! -\cond SKIP Copyright 2012 SINTEF ICT, Applied Mathematics. This file is part of the Open Porous Media project (OPM). @@ -16,8 +16,9 @@ You should have received a copy of the GNU General Public License along with OPM. If not, see . -\endcond */ +/// \endcond + /// \page tutorial2 Flow Solver for a single phase /// \details The flow equations consist of the mass conservation equation /// \f[\nabla\cdot {\bf u}=q\f] and the Darcy law \f[{\bf u} =- \frac{1}{\mu}K\nabla p.\f] Here, @@ -27,9 +28,7 @@ /// We solve the flow equations for a Cartesian grid and we set the source term /// \f$q\f$ be zero except at the left-lower and right-upper corner, where it is equal /// with opposite sign (inflow equal to outflow). -#if HAVE_CONFIG_H #include "config.h" -#endif // HAVE_CONFIG_H #include #include diff --git a/tutorials/tutorial3.cpp b/tutorials/tutorial3.cpp index 952ca818..a79cb067 100644 --- a/tutorials/tutorial3.cpp +++ b/tutorials/tutorial3.cpp @@ -1,5 +1,5 @@ +/// \cond SKIP /*! -\cond SKIP Copyright 2012 SINTEF ICT, Applied Mathematics. This file is part of the Open Porous Media project (OPM). @@ -16,11 +16,9 @@ You should have received a copy of the GNU General Public License along with OPM. If not, see . -\endcond */ -#if HAVE_CONFIG_H +/// \endcond #include "config.h" -#endif // HAVE_CONFIG_H #include #include diff --git a/tutorials/tutorial4.cpp b/tutorials/tutorial4.cpp index 9267ef48..074941a2 100644 --- a/tutorials/tutorial4.cpp +++ b/tutorials/tutorial4.cpp @@ -1,5 +1,5 @@ +/// \cond SKIP /*! -\cond SKIP Copyright 2012 SINTEF ICT, Applied Mathematics. This file is part of the Open Porous Media project (OPM). @@ -16,11 +16,9 @@ You should have received a copy of the GNU General Public License along with OPM. If not, see . -\endcond */ -#if HAVE_CONFIG_H +/// \endcond #include "config.h" -#endif // HAVE_CONFIG_H #include #include