Cleanup: use Blender's code style for doxygen commetns in freestyle

7 files changed, 82 insertions, 82 deletions

diff --git a/source/blender/freestyle/intern/winged_edge/Curvature.cpp b/source/blender/freestyle/intern/winged_edge/Curvature.cpp
index 1984aceb51c..62d767fd2a1 100644
--- a/source/blender/freestyle/intern/winged_edge/Curvature.cpp
+++ b/source/blender/freestyle/intern/winged_edge/Curvature.cpp
@@ -104,7 +104,7 @@ static real angle_from_cotan(WVertex *vo, WVertex *v1, WVertex *v2)
   return (fabs(atan2(denom, udotv)));
 }
 
-/*! gts_vertex_mean_curvature_normal:
+/** gts_vertex_mean_curvature_normal:
  *  \param v: a #WVertex.
  *  \param s: a #GtsSurface.
  *  \param Kh: the Mean Curvature Normal at \a v.
@@ -175,7 +175,7 @@ bool gts_vertex_mean_curvature_normal(WVertex *v, Vec3r &Kh)
   return true;
 }
 
-/*! gts_vertex_gaussian_curvature:
+/** gts_vertex_gaussian_curvature:
  *  \param v: a #WVertex.
  *  \param s: a #GtsSurface.
  *  \param Kg: the Discrete Gaussian Curvature approximation at \a v.
@@ -226,7 +226,7 @@ bool gts_vertex_gaussian_curvature(WVertex *v, real *Kg)
   return true;
 }
 
-/*! gts_vertex_principal_curvatures:
+/** gts_vertex_principal_curvatures:
  *  @Kh: mean curvature.
  *  @Kg: Gaussian curvature.
  *  @K1: first principal curvature.
@@ -279,7 +279,7 @@ static void eigenvector(real a, real b, real c, Vec3r e)
   e[2] = 0.0;
 }
 
-/*! gts_vertex_principal_directions:
+/** gts_vertex_principal_directions:
  *  \param v: a #WVertex.
  *  \param s: a #GtsSurface.
  *  \param Kh: mean curvature normal (a #Vec3r).
diff --git a/source/blender/freestyle/intern/winged_edge/Nature.h b/source/blender/freestyle/intern/winged_edge/Nature.h
index 68323d7122c..996161abee2 100644
--- a/source/blender/freestyle/intern/winged_edge/Nature.h
+++ b/source/blender/freestyle/intern/winged_edge/Nature.h
@@ -23,44 +23,44 @@
 
 namespace Freestyle {
 
-/*! Namespace gathering the different possible natures of 0D and 1D elements of the ViewMap */
+/** Namespace gathering the different possible natures of 0D and 1D elements of the ViewMap */
 namespace Nature {
 
 /* XXX Why not using enums??? */
 /* In order to optimize for space (enum is int) - T.K. */
 
 typedef unsigned short VertexNature;
-/*! true for any 0D element */
+/** true for any 0D element */
 static const VertexNature POINT = 0;  // 0
-/*! true for SVertex */
+/** true for SVertex */
 static const VertexNature S_VERTEX = (1 << 0);  // 1
-/*! true for ViewVertex */
+/** true for ViewVertex */
 static const VertexNature VIEW_VERTEX = (1 << 1);  // 2
-/*! true for NonTVertex */
+/** true for NonTVertex */
 static const VertexNature NON_T_VERTEX = (1 << 2);  // 4
-/*! true for TVertex */
+/** true for TVertex */
 static const VertexNature T_VERTEX = (1 << 3);  // 8
-/*! true for CUSP */
+/** true for CUSP */
 static const VertexNature CUSP = (1 << 4);  // 16
 
 typedef unsigned short EdgeNature;
-/*! true for non feature edges (always false for 1D elements of the ViewMap) */
+/** true for non feature edges (always false for 1D elements of the ViewMap) */
 static const EdgeNature NO_FEATURE = 0;  // 0
-/*! true for silhouettes */
+/** true for silhouettes */
 static const EdgeNature SILHOUETTE = (1 << 0);  // 1
-/*! true for borders */
+/** true for borders */
 static const EdgeNature BORDER = (1 << 1);  // 2
-/*! true for creases */
+/** true for creases */
 static const EdgeNature CREASE = (1 << 2);  // 4
-/*! true for ridges */
+/** true for ridges */
 static const EdgeNature RIDGE = (1 << 3);  // 8
-/*! true for valleys */
+/** true for valleys */
 static const EdgeNature VALLEY = (1 << 4);  // 16
-/*! true for suggestive contours */
+/** true for suggestive contours */
 static const EdgeNature SUGGESTIVE_CONTOUR = (1 << 5);  // 32
-/*! true for material boundaries */
+/** true for material boundaries */
 static const EdgeNature MATERIAL_BOUNDARY = (1 << 6);  // 64
-/*! true for user-defined edge marks */
+/** true for user-defined edge marks */
 static const EdgeNature EDGE_MARK = (1 << 7);  // 128
 
 }  // end of namespace Nature
diff --git a/source/blender/freestyle/intern/winged_edge/WEdge.cpp b/source/blender/freestyle/intern/winged_edge/WEdge.cpp
index 0811fe336b7..356b641a254 100644
--- a/source/blender/freestyle/intern/winged_edge/WEdge.cpp
+++ b/source/blender/freestyle/intern/winged_edge/WEdge.cpp
@@ -25,7 +25,7 @@
 
 namespace Freestyle {
 
-/*! Temporary structures */
+/** Temporary structures */
 class vertexdata {
  public:
   WVertex *_copy;
diff --git a/source/blender/freestyle/intern/winged_edge/WEdge.h b/source/blender/freestyle/intern/winged_edge/WEdge.h
index 42a8e62990f..125dec27b8a 100644
--- a/source/blender/freestyle/intern/winged_edge/WEdge.h
+++ b/source/blender/freestyle/intern/winged_edge/WEdge.h
@@ -76,14 +76,14 @@ class WVertex {
     _Border = -1;
   }
 
-  /*! Copy constructor */
+  /** Copy constructor */
   WVertex(WVertex &iBrother);
   virtual WVertex *duplicate();
   virtual ~WVertex()
   {
   }
 
-  /*! accessors */
+  /** accessors */
   inline Vec3f &GetVertex()
   {
     return _Vertex;
@@ -111,7 +111,7 @@ class WVertex {
 
   bool isBoundary();
 
-  /*! modifiers */
+  /** modifiers */
   inline void setVertex(const Vec3f &v)
   {
     _Vertex = v;
@@ -147,7 +147,7 @@ class WVertex {
     }
   }
 
-  /*! Adds an edge to the edges list */
+  /** Adds an edge to the edges list */
   void AddEdge(WEdge *iEdge);
 
   virtual void ResetUserData()
@@ -156,7 +156,7 @@ class WVertex {
   }
 
  public:
-  /*! Iterator to iterate over a vertex incoming edges in the CCW order*/
+  /** Iterator to iterate over a vertex incoming edges in the CCW order*/
 #if defined(__GNUC__) && (__GNUC__ < 3)
   class incoming_edge_iterator : public input_iterator<WOEdge *, ptrdiff_t>
 #else
@@ -247,7 +247,7 @@ class WVertex {
 #endif
   };
 
-  /*! Iterator to iterate over a vertex faces in the CCW order */
+  /** Iterator to iterate over a vertex faces in the CCW order */
 #if defined(__GNUC__) && (__GNUC__ < 3)
   class face_iterator : public input_iterator<WFace *, ptrdiff_t>
 #else
@@ -336,7 +336,7 @@ class WVertex {
   };
 
  public:
-  /*! iterators access */
+  /** iterators access */
   virtual incoming_edge_iterator incoming_edges_begin();
   virtual incoming_edge_iterator incoming_edges_end();
 
@@ -404,11 +404,11 @@ class WOEdge {
 
   virtual ~WOEdge(){};  // soc
 
-  /*! copy constructor */
+  /** copy constructor */
   WOEdge(WOEdge &iBrother);
   virtual WOEdge *duplicate();
 
-  /*! accessors */
+  /** accessors */
 #if 0
   inline WOEdge *GetaCWEdge()
   {
@@ -466,7 +466,7 @@ class WOEdge {
     return _angle;
   }
 
-  /*! modifiers */
+  /** modifiers */
 #if 0
   inline void SetaCWEdge(WOEdge *pe)
   {
@@ -520,7 +520,7 @@ class WOEdge {
     _pOwner = pe;
   }
 
-  /*! Retrieves the list of edges in CW order */
+  /** Retrieves the list of edges in CW order */
   inline void RetrieveCWOrderedEdges(vector<WEdge *> &oEdges);
 
   WOEdge *twin();
@@ -579,7 +579,7 @@ class WEdge {
     userdata = NULL;
   }
 
-  /*! Copy constructor */
+  /** Copy constructor */
   WEdge(WEdge &iBrother);
   virtual WEdge *duplicate();
 
@@ -596,7 +596,7 @@ class WEdge {
     }
   }
 
-  /*! checks whether two WEdge have a common vertex.
+  /** checks whether two WEdge have a common vertex.
    *  Returns a pointer on the common vertex if it exists, NULL otherwise.
    */
   static inline WVertex *CommonVertex(WEdge *iEdge1, WEdge *iEdge2)
@@ -619,7 +619,7 @@ class WEdge {
     return NULL;
   }
 
-  /*! accessors */
+  /** accessors */
   inline WOEdge *GetaOEdge()
   {
     return _paOEdge;
@@ -675,7 +675,7 @@ class WEdge {
     }
   }
 
-  /*! modifiers */
+  /** modifiers */
   inline void setaOEdge(WOEdge *iEdge)
   {
     _paOEdge = iEdge;
@@ -754,14 +754,14 @@ class WFace {
     _FrsMaterialIndex = 0;
   }
 
-  /*! copy constructor */
+  /** copy constructor */
   WFace(WFace &iBrother);
   virtual WFace *duplicate();
   virtual ~WFace()
   {
   }
 
-  /*! accessors */
+  /** accessors */
   inline const vector<WOEdge *> &getEdgeList()
   {
     return _OEdgeList;
@@ -794,7 +794,7 @@ class WFace {
 
   const FrsMaterial &frs_material();
 
-  /*! The vertex of index i corresponds to the a vertex of the edge of index i */
+  /** The vertex of index i corresponds to the a vertex of the edge of index i */
   inline WVertex *GetVertex(unsigned int index)
   {
 #if 0
@@ -805,7 +805,7 @@ class WFace {
     return _OEdgeList[index]->GetaVertex();
   }
 
-  /*! returns the index at which iVertex is stored in the array.
+  /** returns the index at which iVertex is stored in the array.
    * returns -1 if iVertex doesn't belong to the face.
    */
   inline int GetIndex(WVertex *iVertex)
@@ -868,19 +868,19 @@ class WFace {
     return _VerticesTexCoords;
   }
 
-  /*! Returns the normal of the vertex of index index */
+  /** Returns the normal of the vertex of index index */
   inline Vec3f &GetVertexNormal(int index)
   {
     return _VerticesNormals[index];
   }
 
-  /*! Returns the tex coords of the vertex of index index */
+  /** Returns the tex coords of the vertex of index index */
   inline Vec2f &GetVertexTexCoords(int index)
   {
     return _VerticesTexCoords[index];
   }
 
-  /*! Returns the normal of the vertex iVertex for that face */
+  /** Returns the normal of the vertex iVertex for that face */
   inline Vec3f &GetVertexNormal(WVertex *iVertex)
   {
     int i = 0;
@@ -933,7 +933,7 @@ class WFace {
     return _OEdgeList.size();
   }
 
-  /*! Returns true if the face has one ot its edge which is a border edge */
+  /** Returns true if the face has one ot its edge which is a border edge */
   inline bool isBorder() const
   {
     for (vector<WOEdge *>::const_iterator woe = _OEdgeList.begin(), woeend = _OEdgeList.end();
@@ -946,7 +946,7 @@ class WFace {
     return false;
   }
 
-  /*! modifiers */
+  /** modifiers */
   inline void setEdgeList(const vector<WOEdge *> &iEdgeList)
   {
     _OEdgeList = iEdgeList;
@@ -982,13 +982,13 @@ class WFace {
     _Mark = iMark;
   }
 
-  /*! designed to build a specialized WEdge for use in MakeEdge */
+  /** designed to build a specialized WEdge for use in MakeEdge */
   virtual WEdge *instanciateEdge() const
   {
     return new WEdge;
   }
 
-  /*! Builds an oriented edge
+  /** Builds an oriented edge
    *  Returns the built edge.
    *    v1, v2
    *      Vertices at the edge's extremities
@@ -996,18 +996,18 @@ class WFace {
    */
   virtual WOEdge *MakeEdge(WVertex *v1, WVertex *v2);
 
-  /*! Adds an edge to the edges list */
+  /** Adds an edge to the edges list */
   inline void AddEdge(WOEdge *iEdge)
   {
     _OEdgeList.push_back(iEdge);
   }
 
-  /*! For triangles, returns the edge opposite to the vertex in e.
+  /** For triangles, returns the edge opposite to the vertex in e.
    *  returns false if the face is not a triangle or if the vertex is not found
    */
   bool getOppositeEdge(const WVertex *v, WOEdge *&e);
 
-  /*! compute the area of the face */
+  /** compute the area of the face */
   float getArea();
 
   WShape *getShape();
@@ -1057,7 +1057,7 @@ class WShape {
     _SceneCurrentId++;
   }
 
-  /*! copy constructor */
+  /** copy constructor */
   WShape(WShape &iBrother);
   virtual WShape *duplicate();
 
@@ -1088,7 +1088,7 @@ class WShape {
     }
   }
 
-  /*! accessors */
+  /** accessors */
   inline vector<WEdge *> &getEdgeList()
   {
     return _EdgeList;
@@ -1144,7 +1144,7 @@ class WShape {
     return _LibraryPath;
   }
 
-  /*! modifiers */
+  /** modifiers */
   static inline void setCurrentId(const unsigned id)
   {
     _SceneCurrentId = id;
@@ -1198,13 +1198,13 @@ class WShape {
     _LibraryPath = path;
   }
 
-  /*! designed to build a specialized WFace for use in MakeFace */
+  /** designed to build a specialized WFace for use in MakeFace */
   virtual WFace *instanciateFace() const
   {
     return new WFace;
   }
 
-  /*! adds a new face to the shape
+  /** adds a new face to the shape
    *  returns the built face.
    *   iVertexList
    *      List of face's vertices. These vertices are not added to the WShape vertex list; they are
@@ -1217,7 +1217,7 @@ class WShape {
                           vector<bool> &iFaceEdgeMarksList,
                           unsigned iMaterialIndex);
 
-  /*! adds a new face to the shape. The difference with the previous method is that this one is
+  /** adds a new face to the shape. The difference with the previous method is that this one is
    * designed to build a WingedEdge structure for which there are per vertex normals, opposed to
    * per face normals. returns the built face. iVertexList List of face's vertices. These vertices
    * are not added to the WShape vertex list; they are supposed to be already stored when calling
@@ -1309,7 +1309,7 @@ class WShape {
 #endif
 
  protected:
-  /*!
+  /**
    * Builds the face passed as argument (which as already been allocated)
    * - iVertexList
    *   List of face's vertices. These vertices are not added to the WShape vertex list;
diff --git a/source/blender/freestyle/intern/winged_edge/WFillGrid.h b/source/blender/freestyle/intern/winged_edge/WFillGrid.h
index 095a58675c0..9398a63333f 100644
--- a/source/blender/freestyle/intern/winged_edge/WFillGrid.h
+++ b/source/blender/freestyle/intern/winged_edge/WFillGrid.h
@@ -47,7 +47,7 @@ class WFillGrid {
 
   void fillGrid();
 
-  /*! Accessors */
+  /** Accessors */
   WingedEdge *getWingedEdge()
   {
     return _winged_edge;
@@ -58,7 +58,7 @@ class WFillGrid {
     return _grid;
   }
 
-  /*! Modifiers */
+  /** Modifiers */
   void setWingedEdge(WingedEdge *winged_edge)
   {
     if (winged_edge) {
diff --git a/source/blender/freestyle/intern/winged_edge/WSFillGrid.h b/source/blender/freestyle/intern/winged_edge/WSFillGrid.h
index 5393f57d2cd..d4e7f3ca76b 100644
--- a/source/blender/freestyle/intern/winged_edge/WSFillGrid.h
+++ b/source/blender/freestyle/intern/winged_edge/WSFillGrid.h
@@ -43,7 +43,7 @@ class WSFillGrid {
 
   void fillGrid();
 
-  /*! Accessors */
+  /** Accessors */
   WingedEdge *getWingedEdge()
   {
     return _winged_edge;
@@ -54,7 +54,7 @@ class WSFillGrid {
     return _grid;
   }
 
-  /*! Modifiers */
+  /** Modifiers */
   void setWingedEdge(WingedEdge *winged_edge)
   {
     if (winged_edge) {
diff --git a/source/blender/freestyle/intern/winged_edge/WXEdge.h b/source/blender/freestyle/intern/winged_edge/WXEdge.h
index 8fe99f9bb93..f95913c23f3 100644
--- a/source/blender/freestyle/intern/winged_edge/WXEdge.h
+++ b/source/blender/freestyle/intern/winged_edge/WXEdge.h
@@ -52,7 +52,7 @@ class WXVertex : public WVertex {
     _curvatures = NULL;
   }
 
-  /*! Copy constructor */
+  /** Copy constructor */
   WXVertex(WXVertex &iBrother) : WVertex(iBrother)
   {
     _curvatures = new CurvatureInfo(*iBrother._curvatures);
@@ -135,7 +135,7 @@ class WXEdge : public WEdge {
     _order = 0;
   }
 
-  /*! Copy constructor */
+  /** Copy constructor */
   inline WXEdge(WXEdge &iBrother) : WEdge(iBrother)
   {
     _nature = iBrother.nature();
@@ -159,7 +159,7 @@ class WXEdge : public WEdge {
     _nature = _nature & ~Nature::SUGGESTIVE_CONTOUR;
   }
 
-  /*! accessors */
+  /** accessors */
   inline WXNature nature()
   {
     return _nature;
@@ -175,7 +175,7 @@ class WXEdge : public WEdge {
     return _order;
   }
 
-  /*! modifiers */
+  /** modifiers */
   inline void setFront(bool iFront)
   {
     _front = iFront;
@@ -209,7 +209,7 @@ class WXEdge : public WEdge {
  *                                *
  **********************************/
 
-/*! Class to store a smooth edge (i.e Hertzman & Zorin smooth silhouette edges) */
+/** Class to store a smooth edge (i.e Hertzman & Zorin smooth silhouette edges) */
 class WXSmoothEdge {
  public:
   typedef unsigned short Configuration;
@@ -278,7 +278,7 @@ class WXSmoothEdge {
     return _config;
   }
 
-  /*! modifiers */
+  /** modifiers */
   inline void setWOeA(WOEdge *iwoea)
   {
     _woea = iwoea;
@@ -439,15 +439,15 @@ class WXFaceLayer {
     }
   }
 
-  /*! If one of the face layer vertex has a DotP equal to 0, this method returns the vertex where
+  /** If one of the face layer vertex has a DotP equal to 0, this method returns the vertex where
    * it happens */
   unsigned int Get0VertexIndex() const;
 
-  /*! In case one of the edge of the triangle is a smooth edge, this method allows to retrieve the
+  /** In case one of the edge of the triangle is a smooth edge, this method allows to retrieve the
    * concerned edge */
   unsigned int GetSmoothEdgeIndex() const;
 
-  /*! retrieves the edges of the triangle for which the signs are different (a null value is not
+  /** retrieves the edges of the triangle for which the signs are different (a null value is not
    * considered) for the dotp values at each edge extremity
    */
   void RetrieveCuspEdgesIndices(vector<int> &oCuspEdges);
@@ -512,7 +512,7 @@ class WXFace : public WFace {
     _front = false;
   }
 
-  /*! Copy constructor */
+  /** Copy constructor */
   WXFace(WXFace &iBrother) : WFace(iBrother)
   {
     _center = iBrother.center();
@@ -545,13 +545,13 @@ class WXFace : public WFace {
     }
   }
 
-  /*! designed to build a specialized WEdge for use in MakeEdge */
+  /** designed to build a specialized WEdge for use in MakeEdge */
   virtual WEdge *instanciateEdge() const
   {
     return new WXEdge;
   }
 
-  /*! accessors */
+  /** accessors */
   inline Vec3f &center()
   {
     return _center;
@@ -590,7 +590,7 @@ class WXFace : public WFace {
     return _SmoothLayers;
   }
 
-  /*! retrieve the smooth edges that match the Nature given as argument */
+  /** retrieve the smooth edges that match the Nature given as argument */
   void retrieveSmoothEdges(WXNature iNature, vector<WXSmoothEdge *> &oSmoothEdges)
   {
     for (vector<WXFaceLayer *>::iterator wxf = _SmoothLayers.begin(), wxfend = _SmoothLayers.end();
@@ -624,7 +624,7 @@ class WXFace : public WFace {
     }
   }
 
-  /*! modifiers */
+  /** modifiers */
   inline void setCenter(const Vec3f &iCenter)
   {
     _center = iCenter;
@@ -674,7 +674,7 @@ class WXFace : public WFace {
     _SmoothLayers = layersToKeep;
   }
 
-  /*! Clears everything */
+  /** Clears everything */
   inline void Clear()
   {
     for (vector<WXFaceLayer *>::iterator wxf = _SmoothLayers.begin(), wxfend = _SmoothLayers.end();
@@ -724,7 +724,7 @@ class WXShape : public WShape {
     _computeViewIndependent = true;
   }
 
-  /*! copy constructor */
+  /** copy constructor */
   inline WXShape(WXShape &iBrother) : WShape(iBrother)
   {
     _computeViewIndependent = iBrother._computeViewIndependent;
@@ -750,13 +750,13 @@ class WXShape : public WShape {
     _computeViewIndependent = iFlag;
   }
 
-  /*! designed to build a specialized WFace for use in MakeFace */
+  /** designed to build a specialized WFace for use in MakeFace */
   virtual WFace *instanciateFace() const
   {
     return new WXFace;
   }
 
-  /*!
+  /**
    * Adds a new face to the shape returns the built face.
    * - iVertexList
    *   List of face's vertices.
@@ -768,7 +768,7 @@ class WXShape : public WShape {
                           vector<bool> &iFaceEdgeMarksList,
                           unsigned iMaterialIndex);
 
-  /*!
+  /**
    * Adds a new face to the shape.
    * The difference with the previous method is that this one is designed to build a WingedEdge
    * structure for which there are per vertex normals, opposed to per face normals.
@@ -792,7 +792,7 @@ class WXShape : public WShape {
                           vector<bool> &iFaceEdgeMarksList,
                           unsigned iMaterialIndex);
 
-  /*! Reset all edges and vertices flags (which might have been set up on a previous pass) */
+  /** Reset all edges and vertices flags (which might have been set up on a previous pass) */
   virtual void Reset()
   {
     // Reset Edges
@@ -807,7 +807,7 @@ class WXShape : public WShape {
       ((WXFace *)(*wf))->Reset();
     }
   }
-  /*! accessors */
+  /** accessors */
 
 #ifdef WITH_CXX_GUARDEDALLOC
   MEM_CXX_CLASS_ALLOC_FUNCS("Freestyle:WXShape")