]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Provide links from functions to a module.
authorbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 6 Jun 2012 21:42:56 +0000 (21:42 +0000)
committerbangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 6 Jun 2012 21:42:56 +0000 (21:42 +0000)
git-svn-id: https://svn.dealii.org/trunk@25611 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/include/deal.II/grid/tria.h
deal.II/include/deal.II/grid/tria_accessor.h

index 61662fb679af8b39e60a4cac0a893ef92d6e362c..f8b2f5cf0df4007ab47b399d47287548d79c1722 100644 (file)
@@ -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<dim,spacedim> &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<dim,spacedim> & 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<types::boundary_id_t> get_boundary_indicators() const;
 
index 655c2ebad82cb715ec02e806ca830cb930d48b27..b5d98929718e9f1c051a2fb29065f70d0c6aadf9 100644 (file)
@@ -1065,6 +1065,8 @@ class TriaAccessor : public TriaAccessorBase<structdim, dim, 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) const;
 
@@ -1083,6 +1085,8 @@ class TriaAccessor : public TriaAccessorBase<structdim, dim, spacedim>
                                       * 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

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.