From 2aed896a456d81cde73322f080e6adf32fd93e90 Mon Sep 17 00:00:00 2001
From: Hans-Christian Ebke <ebke@cs.rwth-aachen.de>
Date: Thu, 8 Jan 2015 09:29:49 +0000
Subject: [PATCH] Added helpful doxygen descriptions to circulators.

git-svn-id: http://www.openmesh.org/svnrepo/OpenMesh/trunk@1189 fdac6126-5c0c-442c-9429-916003d36597
---
 src/OpenMesh/Core/Mesh/PolyConnectivity.hh | 32 ++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/src/OpenMesh/Core/Mesh/PolyConnectivity.hh b/src/OpenMesh/Core/Mesh/PolyConnectivity.hh
index 0ffa0022..10f91114 100644
--- a/src/OpenMesh/Core/Mesh/PolyConnectivity.hh
+++ b/src/OpenMesh/Core/Mesh/PolyConnectivity.hh
@@ -98,26 +98,45 @@ public:
   /*
    * Vertex-centered circulators
    */
+
+  /**
+   * Enumerates 1-ring vertices in a clockwise fashion.
+   */
   typedef Iterators::GenericCirculatorT<This,  This::VertexHandle,  This::VertexHandle,
           &Iterators::GenericCirculatorBaseT<This>::toVertexHandle>
   VertexVertexIter;
 
+  /**
+   * Enumerates outgoing half edges in a clockwise fashion.
+   */
   typedef Iterators::GenericCirculatorT<This,  This::VertexHandle,  This::HalfedgeHandle,
           &Iterators::GenericCirculatorBaseT<This>::toHalfedgeHandle>
   VertexOHalfedgeIter;
 
+  /**
+   * Enumerates incoming half edges in a clockwise fashion.
+   */
   typedef Iterators::GenericCirculatorT<This,  This::VertexHandle,  This::HalfedgeHandle,
           &Iterators::GenericCirculatorBaseT<This>::toOppositeHalfedgeHandle>
   VertexIHalfedgeIter;
 
+  /**
+   * Enumerates incident faces in a clockwise fashion.
+   */
   typedef Iterators::GenericCirculatorT<This,  This::VertexHandle,  This::FaceHandle,
           &Iterators::GenericCirculatorBaseT<This>::toFaceHandle>
   VertexFaceIter;
 
+  /**
+   * Enumerates incident edges in a clockwise fashion.
+   */
   typedef Iterators::GenericCirculatorT<This,  This::VertexHandle,  This::EdgeHandle,
           &Iterators::GenericCirculatorBaseT<This>::toEdgeHandle>
   VertexEdgeIter;
 
+  /**
+   * Identical to #FaceHalfedgeIter. God knows why this typedef exists.
+   */
   typedef Iterators::GenericCirculatorT<This, This::FaceHandle, This::HalfedgeHandle,
       &Iterators::GenericCirculatorBaseT<This>::toHalfedgeHandle>
   HalfedgeLoopIter;
@@ -131,18 +150,31 @@ public:
   /*
    * Face-centered circulators
    */
+
+  /**
+   * Enumerate incident vertices in a counter clockwise fashion.
+   */
   typedef Iterators::GenericCirculatorT<This,  This::FaceHandle,  This::VertexHandle,
           &Iterators::GenericCirculatorBaseT<This>::toVertexHandle>
   FaceVertexIter;
 
+  /**
+   * Enumerate incident half edges in a counter clockwise fashion.
+   */
   typedef Iterators::GenericCirculatorT<This,  This::FaceHandle,  This::HalfedgeHandle,
           &Iterators::GenericCirculatorBaseT<This>::toHalfedgeHandle>
   FaceHalfedgeIter;
 
+  /**
+   * Enumerate incident edges in a counter clockwise fashion.
+   */
   typedef Iterators::GenericCirculatorT<This,  This::FaceHandle,  This::EdgeHandle,
           &Iterators::GenericCirculatorBaseT<This>::toEdgeHandle>
   FaceEdgeIter;
 
+  /**
+   * Enumerate adjacent faces in a counter clockwise fashion.
+   */
   typedef Iterators::GenericCirculatorT<This,  This::FaceHandle,  This::FaceHandle,
           &Iterators::GenericCirculatorBaseT<This>::toOppositeFaceHandle>
   FaceFaceIter;