Commit 26848da6 authored by Bernd Flemisch's avatar Bernd Flemisch
Browse files

doxygen works again

git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@4239 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent bb511eec
......@@ -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
......
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
# 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
# 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
......@@ -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:
/*!
......
......@@ -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 &params, Scalar pC)
......
......@@ -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 &params, Scalar pC)
......
......@@ -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 &params, Scalar pC)
......
......@@ -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 &params, Scalar pC)
......
......@@ -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 &params, Scalar pC)
......
......@@ -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 &params, Scalar pC)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment