From b1c9ff446b894bcc2c2225a07809503cb18cdbc0 Mon Sep 17 00:00:00 2001 From: guido Date: Thu, 23 Sep 2004 09:12:04 +0000 Subject: [PATCH] Documentation for doxygen git-svn-id: https://svn.dealii.org/trunk@9672 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/base/include/base/config.h.in | 87 ++++++++++++++------------- 1 file changed, 45 insertions(+), 42 deletions(-) diff --git a/deal.II/base/include/base/config.h.in b/deal.II/base/include/base/config.h.in index 08a11f00cf..b4c150105f 100644 --- a/deal.II/base/include/base/config.h.in +++ b/deal.II/base/include/base/config.h.in @@ -29,92 +29,98 @@ // In case of problems in autodetection of features of your build // environment, contact the authors of the library. +/** + * @file + * + * This file is generated by configure in the main + * deal.II directory. It lists all configuration + * variables available in C++ programs. + */ - -/* Defined if the prototype of abort() has a no-throw exception specification. +/** Defined if the prototype of abort() has a no-throw exception specification. */ #undef DEAL_II_ABORT_NOTHROW_EXCEPTION -/* Flag indicating whether there is a bug in the compiler that leads to bogus +/** Flag indicating whether there is a bug in the compiler that leads to bogus warnings for inline class members in anonymous namespaces */ #undef DEAL_II_ANON_NAMESPACE_BOGUS_WARNING -/* Defined if the compiler needs to see the static keyword even for functions +/** Defined if the compiler needs to see the static keyword even for functions in anonymous namespaces, to avoid duplicate symbol errors when linking. For the details, look at aclocal.m4 in the top-level directory. */ #undef DEAL_II_ANON_NAMESPACE_BUG -/* Another test if the compiler needs to see the static keyword even for +/** Another test if the compiler needs to see the static keyword even for functions in anonymous namespaces, to avoid duplicate symbol errors when linking. For the details, look at aclocal.m4 in the top-level directory. */ #undef DEAL_II_ANON_NAMESPACE_LINKAGE_BUG -/* Defined if the compiler has a problem with assigning arrays in conditionals +/** Defined if the compiler has a problem with assigning arrays in conditionals */ #undef DEAL_II_ARRAY_CONDITIONAL_DECAY_BUG -/* Backward compatibility support for functions and classes that do not take +/** Backward compatibility support for functions and classes that do not take an explicit mapping variable, but rather use a default Q1 mapping instead */ #undef DEAL_II_COMPAT_MAPPING -/* Defined if the compiler does not honor the explicit keyword on template +/** Defined if the compiler does not honor the explicit keyword on template constructors. */ #undef DEAL_II_EXPLICIT_CONSTRUCTOR_BUG -/* Defined if the compiler needs a workaround for certain problems with taking +/** Defined if the compiler needs a workaround for certain problems with taking the address of template template functions. For the details, look at aclocal.m4 in the top-level directory. */ #undef DEAL_II_FUNPTR_TEMPLATE_TEMPLATE_BUG -/* Flag indicating whether the library shall be compiled to use the Tecplot +/** Flag indicating whether the library shall be compiled to use the Tecplot interface */ #undef DEAL_II_HAVE_TECPLOT -/* Defined if the compiler refuses to compile the definition of a function +/** Defined if the compiler refuses to compile the definition of a function that was previously declared abstract. */ #undef DEAL_II_IMPLEMENTED_PURE_FUNCTION_BUG -/* Define if we have to work around a bug in Sun's Forte compiler. See the +/** Define if we have to work around a bug in Sun's Forte compiler. See the aclocal.m4 file in the top-level directory for a description of this bug. */ #undef DEAL_II_LOCAL_TYPEDEF_COMP_WORKAROUND -/* Defined if the compiler gets an internal compiler upon some code involving +/** Defined if the compiler gets an internal compiler upon some code involving long doubles, and with optimization. For the details, look at aclocal.m4 in the top-level directory. */ #undef DEAL_II_LONG_DOUBLE_LOOP_BUG -/* Major version number of deal.II */ +/** Major version number of deal.II */ #undef DEAL_II_MAJOR -/* Define if we have to work around a bug in gcc with explicitly instantiating +/** Define if we have to work around a bug in gcc with explicitly instantiating template member operators. See the aclocal.m4 file in the top-level directory for a description of this bug. */ #undef DEAL_II_MEMBER_OP_TEMPLATE_INST -/* Defined if the compiler refuses to specialize an outer class template while +/** Defined if the compiler refuses to specialize an outer class template while keeping a member as a template. For the exact failure mode, look at aclocal.m4 in the top-level directory. */ #undef DEAL_II_MEMBER_TEMPLATE_SPECIALIZATION_BUG -/* Defined if the compiler refuses to allow the explicit specialization of +/** Defined if the compiler refuses to allow the explicit specialization of static member variables. For the exact failure mode, look at aclocal.m4 in the top-level directory. */ #undef DEAL_II_MEMBER_VAR_SPECIALIZATION_BUG -/* Minor version number of deal.II */ +/** Minor version number of deal.II */ #undef DEAL_II_MINOR -/* Set to the minimal number of elements a std::vector can always hold, +/** Set to the minimal number of elements a std::vector can always hold, i.e. its minimal capacity. */ #undef DEAL_II_MIN_BOOL_VECTOR_CAPACITY -/* Set to the minimal number of elements a std::vector can always hold, +/** Set to the minimal number of elements a std::vector can always hold, i.e. its minimal capacity. */ #undef DEAL_II_MIN_VECTOR_CAPACITY -/* Define if we have to work around a bug in gcc with marking all instances of +/** Define if we have to work around a bug in gcc with marking all instances of a template class as friends to this class if the class is inside a namespace. See the aclocal.m4 file in the top-level directory for a description of this bug. */ @@ -135,7 +141,7 @@ member classes when giving a full class specification. */ #undef DEAL_II_NESTED_CLASS_TEMPL_FRIEND_BUG -/* Path to the deal.II directory */ +/** Path to the deal.II directory */ #undef DEAL_II_PATH /* Defined if the compiler does not support the @@ -188,58 +194,55 @@ functionality is available. */ #undef DEAL_II_USE_MT_POSIX_NO_BARRIERS -/* Defined if a PETSc installation was found and is going to be used */ +/** Defined if a PETSc installation was found and is going to be used */ #undef DEAL_II_USE_PETSC -/* Enable the multigrid components of the library */ -#undef ENABLE_MULTIGRID - -/* Define if the compiler provides __builtin_expect */ +/** Define if the compiler provides __builtin_expect */ #undef HAVE_BUILTIN_EXPECT -/* Define to 1 if you have the `gethostname' function. */ +/** Define to 1 if you have the `gethostname' function. */ #undef HAVE_GETHOSTNAME -/* Availability of the MA27 algorithm from HSL */ +/** Availability of the MA27 algorithm from HSL */ #undef HAVE_HSL_MA27 -/* Availability of the MA47 algorithm from HSL */ +/** Availability of the MA47 algorithm from HSL */ #undef HAVE_HSL_MA47 -/* Use the UMFPack library? */ +/** Use the UMFPack library? */ #undef HAVE_UMFPACK -/* Have LAPACK library? */ +/** Have LAPACK library? */ #undef HAVE_LAPACK -/* Have BLAS library? */ +/** Have BLAS library? */ #undef HAVE_BLAS -/* Define if you have the rand_r function */ +/** Define if you have the rand_r function */ #undef HAVE_RAND_R -/* Define if the compiler provides an header file */ +/** Define if the compiler provides an header file */ #undef HAVE_STD_IOSFWD_HEADER -/* Define if the compiler's library in use provides a std::iterator class +/** Define if the compiler's library in use provides a std::iterator class (early gcc versions did not) */ #undef HAVE_STD_ITERATOR_CLASS -/* Define if the compiler's library in use provides std::numeric_limits +/** Define if the compiler's library in use provides std::numeric_limits classes in the appropriate header file */ #undef HAVE_STD_NUMERIC_LIMITS -/* Define if the compiler provides an header file */ +/** Define if the compiler provides an header file */ #undef HAVE_STD_OSTREAM_HEADER -/* Define if the compiler's library in use provides std::i/ostringstream +/** Define if the compiler's library in use provides std::i/ostringstream classes (early gcc versions did not) */ #undef HAVE_STD_STRINGSTREAM -/* Define if the compiler provides __verbose_terminate_handler */ +/** Define if the compiler provides __verbose_terminate_handler */ #undef HAVE_VERBOSE_TERMINATE -/* On SunOS 4.x, the getrusage() function exists, but is not declared in the +/** On SunOS 4.x, the getrusage() function exists, but is not declared in the respective header file , as one would think when reading the man pages. Then we have to declare this function ourselves in those files that use this function. The question whether we have to do so is controlled @@ -261,7 +264,7 @@ /* Define to the version of this package. */ #undef PACKAGE_VERSION -/* If already available, do not define at all. Otherwise, define to __func__ +/** If already available, do not define at all. Otherwise, define to __func__ if that is available. In all other cases, indicate that no information about the present function is available for this compiler. */ #undef __PRETTY_FUNCTION__ -- 2.39.5