From: bangerth <bangerth@0785d39b-7218-0410-832d-ea1e28bc413d>
Date: Sun, 13 Jul 2014 14:15:37 +0000 (+0000)
Subject: Minor comment updates.
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6281753c5261c2eecee0f46cceef7febbe35c46c;p=dealii-svn.git

Minor comment updates.

git-svn-id: https://svn.dealii.org/branches/branch_manifold_id_intermediate@33147 0785d39b-7218-0410-832d-ea1e28bc413d
---

diff --git a/deal.II/include/deal.II/grid/tria_accessor.h b/deal.II/include/deal.II/grid/tria_accessor.h
index 47f19067f9..ac30cef90d 100644
--- a/deal.II/include/deal.II/grid/tria_accessor.h
+++ b/deal.II/include/deal.II/grid/tria_accessor.h
@@ -1220,12 +1220,12 @@ public:
    */
 
   /**
-   * Manifold indicator of this
+   * Return the manifold indicator of this
    * object.
    *
    * If the return value is the special value
    * numbers::flat_manifold_id, then this object is associated with a
-   * standard cartesian Manifold Description.
+   * standard Cartesian Manifold Description.
    *
    * @see @ref GlossManifoldIndicator "Glossary entry on manifold indicators"
    */
@@ -2095,25 +2095,22 @@ public:
   bool at_boundary () const;
 
   /**
-   * Boundary indicator of this
-   * object. The convention for one
-   * dimensional triangulations is
-   * that left end vertices have
-   * boundary indicator zero, and
-   * right end vertices have
-   * boundary indicator one.
+   * Return the boundary indicator of this object. The convention for one
+   * dimensional triangulations is that left end vertices (of each line
+   * segment from which the triangulation may be constructed) have boundary
+   * indicator zero, and right end vertices have boundary indicator one,
+   * unless explicitly set differently.
    *
-   * If the return value is the special
-   * value numbers::internal_face_boundary_id,
-   * then this object is in the
-   * interior of the domain.
+   * If the return value is the special value
+   * numbers::internal_face_boundary_id, then this object is in the interior
+   * of the domain.
    *
    * @see @ref GlossBoundaryIndicator "Glossary entry on boundary indicators"
    */
   types::boundary_id boundary_indicator () const;
 
   /**
-   * Manifold indicator of this
+   * Return the manifold indicator of this
    * object. 
    *
    * @see @ref GlossManifoldIndicator "Glossary entry on manifold indicators"
@@ -2261,21 +2258,20 @@ public:
   void
   set_boundary_indicator (const types::boundary_id);
 
-				     /**
-				      * Set the manifold indicator of
-				      * this vertex. Does nothing so
-				      * far. This function is here
-				      * only to allow dimension
-				      * independent programming.
-				      */
+  /**
+   * Set the manifold indicator of this vertex. This does nothing so far since
+   * manifolds are only used to refine and map objects, but vertices are not
+   * refined and the mapping is trivial. This function is here only to allow
+   * dimension independent programming.
+   */
   void
   set_manifold_id (const types::manifold_id);
 
   /**
-   * Since this object only represents a
-   * single vertex, call
-   * set_boundary_indicator with the same
-   * argument.
+   * Set the boundary indicator of this object and all of its
+   * lower-dimensional sub-objects.  Since this object only represents a
+   * single vertex, there are no lower-dimensional obejct and this function is
+   * equivalent to calling set_boundary_indicator with the same argument.
    *
    * @ingroup boundary
    *
@@ -2283,23 +2279,21 @@ public:
    */
   void
   set_all_boundary_indicators (const types::boundary_id);
+
   /**
-   * @}
-   */
-/**
-   * Since this object only represents a
-   * single vertex, call
-   * set_manifold_id with the same
-   * argument.
+   * Set the manifold indicator of this object and all of its
+   * lower-dimensional sub-objects.  Since this object only represents a
+   * single vertex, there are no lower-dimensional obejct and this function is
+   * equivalent to calling set_manifold_indicator with the same argument.
    *
    * @ingroup manifold
    *
    * @see @ref GlossManifoldIndicator "Glossary entry on manifold indicators"
    */
     
-    void
-    set_all_manifold_ids (const types::manifold_id);
-    /**
+  void
+  set_all_manifold_ids (const types::manifold_id);
+  /**
    * @}
    */