Commit 60f0b546 authored by prudhomm's avatar prudhomm
Browse files

framework for doxygen documentation per library

parent 786c95c8
/**
* @mainpage The LifeV API Reference
*
* This section contains the LifeV online class reference for the current
* development version of LifeV. Additionally, you
* can subscribe or read the <a href="http://www.lifev.org/mailinglists.php">mailing lists</a> for any additions and/or
* modifications to the API.
*
* - <a href="life/lifecore/html/index.html"><b>lifecore</b></a>
* (<a href="life/lifecore/html/classes.html">classes</a>)\n
* <i>Core LifeV classes that are not related to spcific scientific computing.</i>
* - <a href="life/lifemesh/html/index.html"><b>lifemesh</b></a>
* (<a href="life/lifemesh/html/classes.html">classes</a>)\n
* <i>Mesh library.</i>
* - <a href="life/lifearray/html/index.html"><b>lifearray</b></a>
* (<a href="life/lifearray/html/classes.html">classes</a>)\n
* <i>Array classes libray.</i>
* - <a href="life/lifealg/html/index.html"><b>lifealg</b></a>
* (<a href="life/lifealg/html/classes.html">classes</a>)\n
* <i>Algebra libray.</i>
* - <a href="life/lifefem/html/index.html"><b>lifefem</b></a>
* (<a href="life/lifefem/html/classes.html">classes</a>)\n
* <i>Finite Element libray.</i>
* - <a href="life/lifesolver/html/index.html"><b>lifesolver</b></a>
* (<a href="life/lifesolver/html/classes.html">classes</a>)\n
* <i>Solver libray.</i>
* - <a href="life/lifefilters/html/index.html"><b>lifefilter</b></a>
* (<a href="life/lifefilters/html/classes.html">classes</a>)\n
* <i>Filters libray.</i>
*
* More information about the LifeV architecture, check
* the <a href="http://www.lifev.org/doc.php">LifeV Web Site</a>.
*/
/**
* @page search Search the API documentation
*
* <br>Under construction.
*
*/
......@@ -38,3 +38,8 @@ MAINTAINERCLEANFILES = configure.files subdirs
SUBDIRS = admin doc life testsuite
include $(top_srcdir)/admin/Doxyfile.am
apidox-all:
cd life && make apidox
\ No newline at end of file
......@@ -29,6 +29,9 @@ AC_PROG_F77( g77-3.3 g77-3.2 g77 )
AC_PROG_F77_C_O
AC_PROG_LIBTOOL
# doxygen
AC_CHECK_PROG(DOXYGEN, doxygen, [doxygen], [no-doxygen] )
AC_CHECK_PROG(LIFE_HAS_DOT, dot, [yes] )
dnl Check debugging mode for compilation.
......
......@@ -27,3 +27,9 @@ SUFFIXES = .cpp .hpp .idl .c .h .f .F .o .moc
SUBDIRS = lifecore lifearray lifemesh lifealg lifefem lifesolver lifefilters
apidox:
@for i in $(SUBDIRS); do \
(cd $$i && make apidox); \
done
......@@ -34,4 +34,6 @@ lib_LTLIBRARIES = liblifealg.la
liblifealg_la_SOURCES = dataAztec.cpp dataNewton.cpp pattern.cpp values.cpp
liblifealg_la_LIBADD = ../lifecore/liblifecore.la $(aztec_libs)
\ No newline at end of file
liblifealg_la_LIBADD = ../lifecore/liblifecore.la $(aztec_libs)
include $(top_srcdir)/admin/Doxyfile.am
\ No newline at end of file
......@@ -31,4 +31,6 @@ include_HEADERS = RNM.hpp RNM_op.hpp RNM_opc.hpp RNM_tpl.hpp tab.hpp \
#lib_LTLIBRARIES = lifearray.la
#lifearray_la_SOURCES = dummy.cpp
\ No newline at end of file
#lifearray_la_SOURCES = dummy.cpp
include $(top_srcdir)/admin/Doxyfile.am
\ No newline at end of file
......@@ -117,6 +117,7 @@ public:
//! gives the front of the vector
inline Real * giveVec(){return &((*this)[0]);}
inline UInt size() const {return _size;}
inline UInt nbcomp() const {return _nbcomp;}
};
......@@ -363,6 +364,7 @@ template<typename VectorType>
PhysVectUnknown<VectorType>::PhysVectUnknown(UInt const Ndof)
:
super(nDimensions*Ndof),
//@}
_size(nDimensions*Ndof)
{
}
......
......@@ -33,3 +33,5 @@ dataTime.cpp subDomainNeighbors.cpp switch.cpp util_string.cpp
liblifecore_la_LIBADD = $(aztec_libs)
include $(top_srcdir)/admin/Doxyfile.am
\ No newline at end of file
......@@ -45,3 +45,6 @@ refHdivFE.cpp refHybridFE.cpp staticBdFE.cpp
liblifefem_la_LIBADD = ../lifemesh/liblifemesh.la ../lifealg/liblifealg.la
include $(top_srcdir)/admin/Doxyfile.am
\ No newline at end of file
......@@ -29,4 +29,6 @@ include_HEADERS = gmsh_wrtrs.hpp medit_wrtrs.hpp openDX_wrtrs.hpp vtk_wrtrs.hpp
lib_LTLIBRARIES = liblifefilters.la
liblifefilters_la_SOURCES = medit_wrtrs.cpp vtk_wrtrs.cpp
liblifefilters_la_LIBADD = ../lifefem/liblifefem.la
\ No newline at end of file
liblifefilters_la_LIBADD = ../lifefem/liblifefem.la
include $(top_srcdir)/admin/Doxyfile.am
\ No newline at end of file
......@@ -33,3 +33,6 @@ liblifemesh_la_SOURCES = bareItems.cpp basisElSh.cpp geo0D.cpp identifier.cpp \
markers_base.cpp readMesh3D.cpp regionMesh3D.cpp mesh_util.cpp mesh_util_base.cpp
liblifemesh_la_LIBADD = ../lifecore/liblifecore.la
include $(top_srcdir)/admin/Doxyfile.am
\ No newline at end of file
......@@ -28,4 +28,6 @@ dataNavierStokes.hpp dataSimplifiedStructure.hpp simplifiedStructure.hpp
#lib_LTLIBRARIES = lifesolver.la
#lifesolver_la_SOURCES =
\ No newline at end of file
#lifesolver_la_SOURCES =
include $(top_srcdir)/admin/Doxyfile.am
\ No newline at end of file
Supports Markdown
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