From 12457166dc786c7cb5d8ee0333a2d546b499d5a8 Mon Sep 17 00:00:00 2001 From: Timo Heister Date: Sat, 6 Feb 2016 16:49:01 -0500 Subject: [PATCH] various documentation fixes --- doc/doxygen/headers/concepts.h | 4 ++-- doc/news/changes.h | 11 ++++++----- include/deal.II/dofs/dof_tools.h | 2 +- include/deal.II/grid/grid_generator.h | 3 +++ include/deal.II/grid/grid_tools.h | 6 +++--- 5 files changed, 15 insertions(+), 11 deletions(-) diff --git a/doc/doxygen/headers/concepts.h b/doc/doxygen/headers/concepts.h index 4488cec3df..8d3781d35a 100644 --- a/doc/doxygen/headers/concepts.h +++ b/doc/doxygen/headers/concepts.h @@ -117,8 +117,8 @@ * DoFHandler::begin_active()) and typedefs (such as * DoFHandler::active_cell_iterator) for managing collections of cells. * - * Triangulation&nnbsp;s, DoFHandler&nnbsp;s, and hp::DoFHandler&nnbsp;s may - * all be considered as containers of cells. In fact, the most important parts + * Triangulation, DoFHandler, and hp::DoFHandler may + * all be considered as a container of cells. In fact, the most important parts * of the public interface of these classes consists simply of the ability to * get iterators to their elements. Since these parts of the interface are * generic, i.e., the functions have the same name in all classes, it is diff --git a/doc/news/changes.h b/doc/news/changes.h index 72a51d3175..eb4562206c 100644 --- a/doc/news/changes.h +++ b/doc/news/changes.h @@ -940,8 +940,9 @@ inconvenience this causes. (Alberto Sartori, 2015/09/04, David Wells, 2016/01/18-2016/01/28) -
  • New: There is now a function SparsityPattern::print_svg() which prints the sparsity of the matrix - in a .svg file which can be opened in a web browser. +
  • New: There is now a function SparsityPattern::print_svg() which prints + the sparsity of the matrix in a .svg file which can be opened in a web + browser.
    (Conrad Clevenger, 2015/09/03)
  • @@ -967,9 +968,9 @@ inconvenience this causes. (Wolfgang Bangerth, 2015/09/02) -
  • New: introduced hp::FECollection::find_least_face_dominating_fe(const std::set &fes) - which aims to find the least dominating finite element w.r.t. those provided - as fe_indices in @p fes. +
  • New: introduced hp::FECollection::find_least_face_dominating_fe(const + std::set &fes) which aims to find the least dominating finite + element w.r.t. those provided as fe_indices in @p fes.
    (Denis Davydov, Wolfgang Bangerth, 2015/08/31)
  • diff --git a/include/deal.II/dofs/dof_tools.h b/include/deal.II/dofs/dof_tools.h index 8e1054131b..3fdac2a8a8 100644 --- a/include/deal.II/dofs/dof_tools.h +++ b/include/deal.II/dofs/dof_tools.h @@ -1668,7 +1668,7 @@ namespace DoFTools * processor. Note that this includes the ones that this subdomain "owns" * (i.e. the ones for which get_subdomain_association() returns a value * equal to the subdomain given here and that are selected by the - * extract_locally_owned() function) but also all of those that sit on the + * extract_locally_owned_dofs() function) but also all of those that sit on the * boundary between the given subdomain and other subdomain. In essence, * degrees of freedom that sit on boundaries between subdomain will be in * the index sets returned by this function for more than one subdomain. diff --git a/include/deal.II/grid/grid_generator.h b/include/deal.II/grid/grid_generator.h index f6d17c586b..299cc8004d 100644 --- a/include/deal.II/grid/grid_generator.h +++ b/include/deal.II/grid/grid_generator.h @@ -373,6 +373,9 @@ namespace GridGenerator * @param colorize Assign different boundary ids if set to true. * * @note Implemented for all combinations of @p dim and @p spacedim. + * + * @note You likely need to help the compiler by explicitly specifying the + * two template parameters when calling this function. */ template void diff --git a/include/deal.II/grid/grid_tools.h b/include/deal.II/grid/grid_tools.h index 13bca31ef3..2ce468c207 100644 --- a/include/deal.II/grid/grid_tools.h +++ b/include/deal.II/grid/grid_tools.h @@ -362,7 +362,7 @@ namespace GridTools * adjacent cells that are returned. However, it will always be either a * vertex of a cell or be a hanging node located on a face or an edge of it. * - * @param mesh A variable of a type that satisfies the requirements of + * @param container A variable of a type that satisfies the requirements of * the @ref ConceptMeshType "MeshType concept". * @param vertex_index The index of the vertex for which we try to find * adjacent cells. @@ -990,7 +990,7 @@ namespace GridTools * of Container from the function call. You need to * specify it as an explicit template argument following the * function name. This type has to satisfy the requirements of a - * mesh container (see @ref GlossMeshAsAContainer). + * mesh container (see @ref ConceptMeshType). * * @param[in] patch_cells A vector of active cells for which * this function finds the parents at the coarsest common @@ -1060,7 +1060,7 @@ namespace GridTools * of Container from the function call. You need to * specify it as an explicit template argument following the * function name. This type that satisfies the requirements of a - * mesh container (see @ref GlossMeshAsAContainer). + * mesh container (see @ref ConceptMeshType). * * @param[in] patch A vector of active cells from a common triangulation. * These cells may or may not all be at the same refinement level. -- 2.39.5