From 26848da6e9fcf7cb339ac0d4cd21e3cda16576cf Mon Sep 17 00:00:00 2001
From: Bernd Flemisch <bernd@iws.uni-stuttgart.de>
Date: Mon, 6 Sep 2010 12:00:07 +0000
Subject: [PATCH] doxygen works again
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@4239 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
configure.ac | 1 +
doc/Makefile.am | 12 ++++----
doc/doxygen/Doxylocal | 29 ++-----------------
doc/doxygen/Makefile.am | 6 +++-
dumux/boxmodels/common/boxmodel.hh | 5 ++++
.../fluidmatrixinteractions/2p/brookscorey.hh | 2 +-
.../fluidmatrixinteractions/2p/efftoabslaw.hh | 2 +-
.../2p/linearmaterial.hh | 2 +-
.../2p/regularizedlinearmaterial.hh | 2 +-
.../2p/regularizedvangenuchten.hh | 2 +-
.../2p/vangenuchten.hh | 2 +-
11 files changed, 24 insertions(+), 41 deletions(-)
diff --git a/configure.ac b/configure.ac
index 55700aa1d4..1699216f8b 100644
--- a/configure.ac
+++ b/configure.ac
@@ -86,6 +86,7 @@ AC_CONFIG_FILES([dumux.pc
Makefile
doc/Makefile
doc/doxygen/Makefile
+ doc/doxygen/Doxyfile
doc/handbook/Makefile
dumux/Makefile
dumux/boxmodels/Makefile
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 1d247672f6..961a1b1788 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,12 +1,10 @@
-
SUBDIRS = doxygen handbook
-CURDIR = doc
-BASEDIR = ..
-
-# add list of html files to generate from wml
-PAGES=
-docdir=$(datadir)/doc/dumux
+# setting like in dune-web
+CURDIR=doc
+# position of the web base directory,
+# relative to $(CURDIR)
+BASEDIR=..
include $(top_srcdir)/am/webstuff
include $(top_srcdir)/am/global-rules
diff --git a/doc/doxygen/Doxylocal b/doc/doxygen/Doxylocal
index 6b9a5f6e86..879c09f96d 100644
--- a/doc/doxygen/Doxylocal
+++ b/doc/doxygen/Doxylocal
@@ -1,30 +1,5 @@
# This file contains local changes to the doxygen configuration
# please us '+=' to add file/directories to the lists
-# The INPUT tag can be used to specify the files and/or directories that contain
-# documented source files. You may enter file names like "myfile.cpp" or
-# directories like "/usr/src/myproject". Separate the files or directories
-# with spaces.
-
-INPUT += @top_srcdir@/dune/
-# see e.g. dune-grid for the examples of mainpage and modules
-# INPUT += @srcdir@/mainpage # @srcdir@/modules
-
-# The EXCLUDE tag can be used to specify files and/or directories that should
-# excluded from the INPUT source files. This way you can easily exclude a
-# subdirectory from a directory tree whose root is specified with the INPUT tag.
-
-# EXCLUDE += @top_srcdir@/dune/dumux/test
-
-# The EXAMPLE_PATH tag can be used to specify one or more files or
-# directories that contain example code fragments that are included (see
-# the \include command).
-
-# EXAMPLE_PATH += @top_srcdir@/src
-
-# The IMAGE_PATH tag can be used to specify one or more files or
-# directories that contain image that are included in the documentation (see
-# the \image command).
-
-# IMAGE_PATH += @top_srcdir@/dune/dumux/pics
-
+INPUT += @top_srcdir@/dune/dumux
+EXTRA_PACKAGES += amsmath,amssymb
diff --git a/doc/doxygen/Makefile.am b/doc/doxygen/Makefile.am
index d94c751b4a..a9792f86f9 100644
--- a/doc/doxygen/Makefile.am
+++ b/doc/doxygen/Makefile.am
@@ -1,7 +1,11 @@
-
+# setting like in dune-web
BASEDIR=../..
CURDIR=doc/doxygen
+# add some more stuff to install and tarball
+DOCFILES = $(PAGES)
+EXTRA_DIST = $(PAGES)
+
include $(top_srcdir)/am/doxygen
include $(top_srcdir)/am/global-rules
diff --git a/dumux/boxmodels/common/boxmodel.hh b/dumux/boxmodels/common/boxmodel.hh
index 7c7ef3e87c..a20dfe1229 100644
--- a/dumux/boxmodels/common/boxmodel.hh
+++ b/dumux/boxmodels/common/boxmodel.hh
@@ -561,6 +561,11 @@ public:
writer.addVertexData(x[i], (boost::format("primaryVar%i")%i).str().c_str());
}
+ /*!
+ * \brief Reference to the grid view of the spatial domain.
+ */
+ const GridView &gridView() const
+ { return problem_().gridView(); }
protected:
/*!
diff --git a/dumux/material/fluidmatrixinteractions/2p/brookscorey.hh b/dumux/material/fluidmatrixinteractions/2p/brookscorey.hh
index 7b6eb70abe..d6ba01d22d 100644
--- a/dumux/material/fluidmatrixinteractions/2p/brookscorey.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/brookscorey.hh
@@ -71,7 +71,7 @@ public:
\overline{S}_w = (\frac{p_C}{p_e})^{-\alpha}
\f]
*
- * \param pC Capillary pressure \f$\p_C\f$
+ * \param pC Capillary pressure \f$p_C\f$
* \return The effective saturaion of the wetting phase \f$\overline{S}_w\f$
*/
static Scalar Sw(const Params ¶ms, Scalar pC)
diff --git a/dumux/material/fluidmatrixinteractions/2p/efftoabslaw.hh b/dumux/material/fluidmatrixinteractions/2p/efftoabslaw.hh
index c8369dbed6..20b43f3ef3 100644
--- a/dumux/material/fluidmatrixinteractions/2p/efftoabslaw.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/efftoabslaw.hh
@@ -55,7 +55,7 @@ public:
/*!
* \brief The saturation-capillary pressure curve.
*
- * \param pC Capillary pressure \f$\p_C\f$
+ * \param pC Capillary pressure \f$p_C\f$
* \return The absolute saturation of the wetting phase \f$S_w\f$
*/
static Scalar Sw(const Params ¶ms, Scalar pC)
diff --git a/dumux/material/fluidmatrixinteractions/2p/linearmaterial.hh b/dumux/material/fluidmatrixinteractions/2p/linearmaterial.hh
index 6a8bf280eb..60cb6b47d5 100644
--- a/dumux/material/fluidmatrixinteractions/2p/linearmaterial.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/linearmaterial.hh
@@ -67,7 +67,7 @@ public:
S_w = 1 - \frac{p_C - p_{C,entry}}{p_{C,max} - p_{C,entry}}
\f]
*
- * \param pC Capillary pressure \f$\p_C\f$
+ * \param pC Capillary pressure \f$p_C\f$
* \return The effective saturaion of the wetting phase \f$\overline{S}_w\f$
*/
static Scalar Sw(const Params ¶ms, Scalar pC)
diff --git a/dumux/material/fluidmatrixinteractions/2p/regularizedlinearmaterial.hh b/dumux/material/fluidmatrixinteractions/2p/regularizedlinearmaterial.hh
index 926579900f..2f18cc9d49 100644
--- a/dumux/material/fluidmatrixinteractions/2p/regularizedlinearmaterial.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/regularizedlinearmaterial.hh
@@ -70,7 +70,7 @@ public:
S_w = 1 - \frac{p_C - p_{C,entry}}{p_{C,max} - p_{C,entry}}
\f]
*
- * \param pC Capillary pressure \f$\p_C\f$
+ * \param pC Capillary pressure \f$p_C\f$
* \return The effective saturaion of the wetting phase \f$\overline{S}_w\f$
*/
static Scalar Sw(const Params ¶ms, Scalar pC)
diff --git a/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchten.hh b/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchten.hh
index 91eccad9ae..b63f48ecb0 100644
--- a/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchten.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchten.hh
@@ -92,7 +92,7 @@ public:
\overline{S}_w = {p_C}^{-1} = ((\alpha p_C)^n + 1)^{-m}
\f]
*
- * \param pC Capillary pressure \f$\p_C\f$
+ * \param pC Capillary pressure \f$p_C\f$
* \return The effective saturaion of the wetting phase \f$\overline{S}_w\f$
*/
static Scalar Sw(const Params ¶ms, Scalar pC)
diff --git a/dumux/material/fluidmatrixinteractions/2p/vangenuchten.hh b/dumux/material/fluidmatrixinteractions/2p/vangenuchten.hh
index d44fb9350f..2c4fe3e1f9 100644
--- a/dumux/material/fluidmatrixinteractions/2p/vangenuchten.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/vangenuchten.hh
@@ -68,7 +68,7 @@ public:
\overline{S}_w = {p_C}^{-1} = ((\alpha p_C)^n + 1)^{-m}
\f]
*
- * \param pC Capillary pressure \f$\p_C\f$
+ * \param pC Capillary pressure \f$p_C\f$
* \return The effective saturaion of the wetting phase \f$\overline{S}_w\f$
*/
static Scalar Sw(const Params ¶ms, Scalar pC)
--
GitLab