From 87ef9673929b75d85aa9979da670eda6dc216145 Mon Sep 17 00:00:00 2001 From: bangerth Date: Wed, 6 Jun 2012 21:42:56 +0000 Subject: [PATCH] Provide links from functions to a module. git-svn-id: https://svn.dealii.org/trunk@25611 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/include/deal.II/grid/tria.h | 8 ++++++++ deal.II/include/deal.II/grid/tria_accessor.h | 21 ++++++++++++++++++++ 2 files changed, 29 insertions(+) diff --git a/deal.II/include/deal.II/grid/tria.h b/deal.II/include/deal.II/grid/tria.h index 61662fb679..f8b2f5cf0d 100644 --- a/deal.II/include/deal.II/grid/tria.h +++ b/deal.II/include/deal.II/grid/tria.h @@ -1832,6 +1832,8 @@ class Triangulation : public Subscriptor * replaces the boundary object given * before by a straight boundary * approximation. + * + * @ingroup boundary */ void set_boundary (const types::boundary_id_t number, const Boundary &boundary_object); @@ -1844,6 +1846,8 @@ class Triangulation : public Subscriptor * undoes assignment of a different * boundary object by the function of * same name and two arguments. + * + * @ingroup boundary */ void set_boundary (const types::boundary_id_t number); @@ -1853,6 +1857,8 @@ class Triangulation : public Subscriptor * this triangulation. Number is * the same as in * @p set_boundary + * + * @ingroup boundary */ const Boundary & get_boundary (const types::boundary_id_t number) const; @@ -1868,6 +1874,8 @@ class Triangulation : public Subscriptor * the number of different * indicators (which is greater * or equal one). + * + * @ingroup boundary */ std::vector get_boundary_indicators() const; diff --git a/deal.II/include/deal.II/grid/tria_accessor.h b/deal.II/include/deal.II/grid/tria_accessor.h index 655c2ebad8..b5d9892971 100644 --- a/deal.II/include/deal.II/grid/tria_accessor.h +++ b/deal.II/include/deal.II/grid/tria_accessor.h @@ -1065,6 +1065,8 @@ class TriaAccessor : public TriaAccessorBase * domain and so cannot determine whether * the value you are trying to set makes * sense under the current circumstances. + * + * @ingroup boundary */ void set_boundary_indicator (const types::boundary_id_t) const; @@ -1083,6 +1085,8 @@ class TriaAccessor : public TriaAccessorBase * of face and edges are all set * at the same time using the * current function. + * + * @ingroup boundary */ void set_all_boundary_indicators (const types::boundary_id_t) const; @@ -2027,6 +2031,16 @@ class TriaAccessor<0, 1, spacedim> */ static int isotropic_child_index (const unsigned int i); + /** + * @} + */ + + /** + * @name Dealing with boundary indicators + */ + /** + * @{ + */ /** * Set the boundary indicator. @@ -2053,6 +2067,8 @@ class TriaAccessor<0, 1, spacedim> * domain and so cannot determine whether * the value you are trying to set makes * sense under the current circumstances. + * + * @ingroup boundary */ void set_boundary_indicator (const types::boundary_id_t); @@ -2062,9 +2078,14 @@ class TriaAccessor<0, 1, spacedim> * single vertex, call * set_boundary_indicator with the same * argument. + * + * @ingroup boundary */ void set_all_boundary_indicators (const types::boundary_id_t); + /** + * @} + */ /** * Return whether the vertex -- 2.39.5