From 91f00a6ad9715458655fb49bce9cec18f8d83760 Mon Sep 17 00:00:00 2001 From: Daniel Garcia-Sanchez Date: Tue, 14 Aug 2018 16:12:45 +0200 Subject: [PATCH] Fix documentation of template instantiations The instantiations for long double and std::complex were removed in commit 352537aca This fixes the documentation --- cmake/scripts/expand_instantiations.cc | 11 +++++------ doc/doxygen/headers/instantiations.h | 15 +++++++-------- 2 files changed, 12 insertions(+), 14 deletions(-) diff --git a/cmake/scripts/expand_instantiations.cc b/cmake/scripts/expand_instantiations.cc index 1ceda76bd7..0928e21884 100644 --- a/cmake/scripts/expand_instantiations.cc +++ b/cmake/scripts/expand_instantiations.cc @@ -19,11 +19,10 @@ // is given as arguments on the command line and contains entries of the // following form: // -------------------- -// REAL_SCALARS := { double; float; long double } +// REAL_SCALARS := { double; float} // COMPLEX_SCALARS := { std::complex; -// std::complex; -// std::complex } -// VECTORS := { Vector; Vector; Vector } +// std::complex} +// VECTORS := { Vector; Vector} // -------------------- // // The input file is typically located in share/deal.II/template-arguments in @@ -55,7 +54,7 @@ // a map from the keys in the expansion lists to the list itself. For // instance, the example above will lead to the entry -// expansion_lists[REAL_SCALARS] = (double, float, long double) +// expansion_lists[REAL_SCALARS] = (double, float) // in this map, among others std::map > expansion_lists; @@ -284,7 +283,7 @@ std::string substitute_tokens (const std::string &text, // read and parse the expansion lists like -// REAL_SCALARS := { double; float; long double } +// REAL_SCALARS := { double; float} // as specified at the top of the file and store them in the global // expansion_lists variable void read_expansion_lists (const std::string &filename) diff --git a/doc/doxygen/headers/instantiations.h b/doc/doxygen/headers/instantiations.h index f1e366f64b..3010d39c5e 100644 --- a/doc/doxygen/headers/instantiations.h +++ b/doc/doxygen/headers/instantiations.h @@ -62,11 +62,9 @@ * arguments is supported and explicit instantiations are provided in * the library. In particular, this includes all the linear algebra * classes that are templatized on the type of the scalar underlying - * stored values: we only support double, - * float, and in some cases long double, - * std::complex@, - * std::complex@, and std::complex@. + * stored values: we only support double, float, + * and in some cases std::complex@ and + * std::complex@. * * * @section Inst2 A few instantiations, most of which are known @@ -83,7 +81,8 @@ * the library for Vector<double>, * Vector<float>, BlockVector<double>, * and BlockVector<float>, for example. However, they may - * also be used with other vector types as long as they satisfy certain + * also be used with other vector types, such as long double + * and std::complex@, as long as they satisfy certain * interfaces, including vector types that are not part of the library but * possibly defined in an application program. In such a case, applications * can instantiate these templates by hand as described in the next section. @@ -94,7 +93,7 @@ * Choose one of your source files to provide the required * instantiations. Say that you want the class template XXXX, * defined in the header file xxxx.h, instantiated with the - * template parameter Lager. Then, your file should contain + * template parameter long double. Then, your file should contain * the lines * @code * // Include class template declaration @@ -104,7 +103,7 @@ * * ... * - * template class XXXX; + * template class XXXX; * @endcode * * -- 2.39.5