From f1e49038543cf75766f4a220f62cdc6cdbc0e27d Mon Sep 17 00:00:00 2001
From: Campbell Barton <ideasman42@gmail.com>
Date: Sat, 26 Jun 2021 21:35:18 +1000
Subject: Cleanup: full sentences in comments, improve comment formatting

---
 source/blender/freestyle/intern/geometry/SweepLine.h     |  2 +-
 .../freestyle/intern/scene_graph/IndexedFaceSet.h        |  2 +-
 source/blender/freestyle/intern/scene_graph/LineRep.h    |  2 +-
 .../blender/freestyle/intern/scene_graph/TriangleRep.h   |  2 +-
 .../freestyle/intern/stroke/AdvancedFunctions1D.h        |  4 ++--
 .../blender/freestyle/intern/stroke/BasicStrokeShaders.h |  6 +++---
 .../blender/freestyle/intern/stroke/ChainingIterators.h  |  2 +-
 source/blender/freestyle/intern/stroke/Curve.h           |  2 +-
 source/blender/freestyle/intern/stroke/Predicates0D.h    |  4 ++--
 source/blender/freestyle/intern/stroke/Predicates1D.h    | 12 ++++++------
 source/blender/freestyle/intern/stroke/Stroke.cpp        |  4 ++--
 source/blender/freestyle/intern/stroke/Stroke.h          | 10 +++++-----
 source/blender/freestyle/intern/view_map/Functions1D.h   |  6 +++---
 source/blender/freestyle/intern/view_map/Interface1D.h   | 10 +++++-----
 source/blender/freestyle/intern/view_map/Silhouette.h    | 16 ++++++++--------
 .../freestyle/intern/view_map/ViewEdgeXBuilder.cpp       |  2 +-
 source/blender/freestyle/intern/view_map/ViewMap.h       | 12 ++++++------
 .../blender/freestyle/intern/view_map/ViewMapIterators.h |  2 +-
 source/blender/freestyle/intern/winged_edge/WEdge.h      |  2 +-
 19 files changed, 51 insertions(+), 51 deletions(-)

(limited to 'source/blender/freestyle')

diff --git a/source/blender/freestyle/intern/geometry/SweepLine.h b/source/blender/freestyle/intern/geometry/SweepLine.h
index ac3417a1afe..1beae73b68a 100644
--- a/source/blender/freestyle/intern/geometry/SweepLine.h
+++ b/source/blender/freestyle/intern/geometry/SweepLine.h
@@ -30,7 +30,7 @@
 
 namespace Freestyle {
 
-/** Class to define the intersection between two segments*/
+/** Class to define the intersection between two segments. */
 template<class Edge> class Intersection {
  public:
   template<class EdgeClass> Intersection(EdgeClass *eA, real ta, EdgeClass *eB, real tb)
diff --git a/source/blender/freestyle/intern/scene_graph/IndexedFaceSet.h b/source/blender/freestyle/intern/scene_graph/IndexedFaceSet.h
index 2b1adfc179c..17f922de467 100644
--- a/source/blender/freestyle/intern/scene_graph/IndexedFaceSet.h
+++ b/source/blender/freestyle/intern/scene_graph/IndexedFaceSet.h
@@ -33,7 +33,7 @@ namespace Freestyle {
 
 class IndexedFaceSet : public Rep {
  public:
-  /** Triangles description style:*/
+  /** Triangles description style: */
   enum TRIANGLES_STYLE {
     TRIANGLE_STRIP,
     TRIANGLE_FAN,
diff --git a/source/blender/freestyle/intern/scene_graph/LineRep.h b/source/blender/freestyle/intern/scene_graph/LineRep.h
index 3a48f175bfd..02725102001 100644
--- a/source/blender/freestyle/intern/scene_graph/LineRep.h
+++ b/source/blender/freestyle/intern/scene_graph/LineRep.h
@@ -134,7 +134,7 @@ class LineRep : public Rep {
     v.visitLineRep(*this);
   }
 
-  /** Computes the line bounding box.*/
+  /** Computes the line bounding box. */
   virtual void ComputeBBox();
 
  private:
diff --git a/source/blender/freestyle/intern/scene_graph/TriangleRep.h b/source/blender/freestyle/intern/scene_graph/TriangleRep.h
index a29ecbd4979..e3f221567b0 100644
--- a/source/blender/freestyle/intern/scene_graph/TriangleRep.h
+++ b/source/blender/freestyle/intern/scene_graph/TriangleRep.h
@@ -136,7 +136,7 @@ class TriangleRep : public Rep {
     v.visitTriangleRep(*this);
   }
 
-  /** Computes the triangle bounding box.*/
+  /** Computes the triangle bounding box. */
   virtual void ComputeBBox();
 };
 
diff --git a/source/blender/freestyle/intern/stroke/AdvancedFunctions1D.h b/source/blender/freestyle/intern/stroke/AdvancedFunctions1D.h
index 07ef0a7039c..486e0fffcdd 100644
--- a/source/blender/freestyle/intern/stroke/AdvancedFunctions1D.h
+++ b/source/blender/freestyle/intern/stroke/AdvancedFunctions1D.h
@@ -66,13 +66,13 @@ class DensityF1D : public UnaryFunction1D<double> {
   {
   }
 
-  /** Returns the string "DensityF1D"*/
+  /** Returns the string "DensityF1D". */
   string getName() const
   {
     return "DensityF1D";
   }
 
-  /** the () operator.*/
+  /** the () operator. */
   int operator()(Interface1D &inter)
   {
     result = integrate(
diff --git a/source/blender/freestyle/intern/stroke/BasicStrokeShaders.h b/source/blender/freestyle/intern/stroke/BasicStrokeShaders.h
index fcf661ea72f..2b578dd963a 100644
--- a/source/blender/freestyle/intern/stroke/BasicStrokeShaders.h
+++ b/source/blender/freestyle/intern/stroke/BasicStrokeShaders.h
@@ -66,7 +66,7 @@ class ConstantThicknessShader : public StrokeShader {
   {
   }
 
-  /** Returns the string "ConstantThicknessShader".*/
+  /** Returns the string "ConstantThicknessShader". */
   virtual string getName() const
   {
     return "ConstantThicknessShader";
@@ -126,7 +126,7 @@ class IncreasingThicknessShader : public StrokeShader {
     _ThicknessMax = iThicknessMax;
   }
 
-  /** Destructor.*/
+  /** Destructor. */
   virtual ~IncreasingThicknessShader()
   {
   }
@@ -171,7 +171,7 @@ class ConstrainedIncreasingThicknessShader : public StrokeShader {
     _ratio = iRatio;
   }
 
-  /** Destructor.*/
+  /** Destructor. */
   virtual ~ConstrainedIncreasingThicknessShader()
   {
   }
diff --git a/source/blender/freestyle/intern/stroke/ChainingIterators.h b/source/blender/freestyle/intern/stroke/ChainingIterators.h
index c0259471277..93aba258358 100644
--- a/source/blender/freestyle/intern/stroke/ChainingIterators.h
+++ b/source/blender/freestyle/intern/stroke/ChainingIterators.h
@@ -245,7 +245,7 @@ class ChainingIterator : public ViewEdgeInternal::ViewEdgeIterator {
     return _increment;
   }
 
-  /* increments.*/
+  /* Increments. */
   virtual int increment();
   virtual int decrement();
 };
diff --git a/source/blender/freestyle/intern/stroke/Curve.h b/source/blender/freestyle/intern/stroke/Curve.h
index cce5353a5c7..9a05fcd380b 100644
--- a/source/blender/freestyle/intern/stroke/Curve.h
+++ b/source/blender/freestyle/intern/stroke/Curve.h
@@ -61,7 +61,7 @@ using namespace Geometry;
  */
 class CurvePoint : public Interface0D {
  public:  // Implementation of Interface0D
-  /** Returns the string "CurvePoint"*/
+  /** Returns the string "CurvePoint". */
   virtual string getExactTypeName() const
   {
     return "CurvePoint";
diff --git a/source/blender/freestyle/intern/stroke/Predicates0D.h b/source/blender/freestyle/intern/stroke/Predicates0D.h
index cd00d582b30..11cbfb1b831 100644
--- a/source/blender/freestyle/intern/stroke/Predicates0D.h
+++ b/source/blender/freestyle/intern/stroke/Predicates0D.h
@@ -137,7 +137,7 @@ class TrueUP0D : public UnaryPredicate0D {
   {
   }
 
-  /** Returns the string "TrueUP0D"*/
+  /** Returns the string "TrueUP0D". */
   string getName() const
   {
     return "TrueUP0D";
@@ -160,7 +160,7 @@ class FalseUP0D : public UnaryPredicate0D {
   {
   }
 
-  /** Returns the string "FalseUP0D"*/
+  /** Returns the string "FalseUP0D". */
   string getName() const
   {
     return "FalseUP0D";
diff --git a/source/blender/freestyle/intern/stroke/Predicates1D.h b/source/blender/freestyle/intern/stroke/Predicates1D.h
index ceb2e7fcc17..e7be9d863dc 100644
--- a/source/blender/freestyle/intern/stroke/Predicates1D.h
+++ b/source/blender/freestyle/intern/stroke/Predicates1D.h
@@ -144,7 +144,7 @@ class TrueUP1D : public UnaryPredicate1D {
   {
   }
 
-  /** Returns the string "TrueUP1D"*/
+  /** Returns the string "TrueUP1D". */
   string getName() const
   {
     return "TrueUP1D";
@@ -167,7 +167,7 @@ class FalseUP1D : public UnaryPredicate1D {
   {
   }
 
-  /** Returns the string "FalseUP1D"*/
+  /** Returns the string "FalseUP1D". */
   string getName() const
   {
     return "FalseUP1D";
@@ -225,7 +225,7 @@ class ContourUP1D : public UnaryPredicate1D {
   Functions1D::CurveNatureF1D _getNature;
 
  public:
-  /** Returns the string "ContourUP1D"*/
+  /** Returns the string "ContourUP1D". */
   string getName() const
   {
     return "ContourUP1D";
@@ -300,7 +300,7 @@ class EqualToTimeStampUP1D : public UnaryPredicate1D {
     _timeStamp = ts;
   }
 
-  /** Returns the string "EqualToTimeStampUP1D"*/
+  /** Returns the string "EqualToTimeStampUP1D". */
   string getName() const
   {
     return "EqualToTimeStampUP1D";
@@ -326,7 +326,7 @@ class EqualToChainingTimeStampUP1D : public UnaryPredicate1D {
     _timeStamp = ts;
   }
 
-  /** Returns the string "EqualToChainingTimeStampUP1D"*/
+  /** Returns the string "EqualToChainingTimeStampUP1D". */
   string getName() const
   {
     return "EqualToChainingTimeStampUP1D";
@@ -364,7 +364,7 @@ class ShapeUP1D : public UnaryPredicate1D {
     _id = Id(idFirst, idSecond);
   }
 
-  /** Returns the string "ShapeUP1D"*/
+  /** Returns the string "ShapeUP1D". */
   string getName() const
   {
     return "ShapeUP1D";
diff --git a/source/blender/freestyle/intern/stroke/Stroke.cpp b/source/blender/freestyle/intern/stroke/Stroke.cpp
index 0de3e03d44a..956ba2743d7 100644
--- a/source/blender/freestyle/intern/stroke/Stroke.cpp
+++ b/source/blender/freestyle/intern/stroke/Stroke.cpp
@@ -625,7 +625,7 @@ int Stroke::Resample(int iNPoints)
   // add last:
   ++it;
   ++next;
-  if ((it != itend) && (next == itend) /* && (t == 0.0f)*/) {
+  if ((it != itend) && (next == itend) /* && (t == 0.0f) */) {
     newVertices.push_back(&(*it));
   }
 
@@ -687,7 +687,7 @@ int Stroke::Resample(float iSampling)
     ++next;
   }
   // add last:
-  if ((it != itend) && (next == itend) /* && (t == 0.0f)*/) {
+  if ((it != itend) && (next == itend) /* && (t == 0.0f) */) {
     newVertices.push_back(&(*it));
   }
 
diff --git a/source/blender/freestyle/intern/stroke/Stroke.h b/source/blender/freestyle/intern/stroke/Stroke.h
index 96a4d2d61ea..209ec86edef 100644
--- a/source/blender/freestyle/intern/stroke/Stroke.h
+++ b/source/blender/freestyle/intern/stroke/Stroke.h
@@ -349,7 +349,7 @@ class StrokeVertex : public CurvePoint {
   /** Builds a stroke vertex from a CurvePoint */
   StrokeVertex(CurvePoint *iPoint);
 
-  /** Builds Stroke Vertex from 2 stroke vertices and an interpolation parameter*/
+  /** Builds Stroke Vertex from 2 stroke vertices and an interpolation parameter. */
   StrokeVertex(StrokeVertex *iA, StrokeVertex *iB, float t3);
 
   /** Builds a stroke from a view vertex and an attribute */
@@ -378,7 +378,7 @@ class StrokeVertex : public CurvePoint {
     return getPoint2D();
   }
 
-  /** Returns the ith 2D point coordinate (i=0 or 1)*/
+  /** Returns the ith 2D point coordinate (i=0 or 1). */
   inline real operator[](const int i) const
   {
     return _Point2d[i];
@@ -516,9 +516,9 @@ class Stroke : public Interface1D {
 
   /** The different blending modes available to similate the interaction media-medium. */
   typedef enum {
-    DRY_MEDIUM,    /**< To simulate a dry medium such as Pencil or Charcoal.*/
-    HUMID_MEDIUM,  /**< To simulate ink painting (color subtraction blending).*/
-    OPAQUE_MEDIUM, /**< To simulate an opaque medium (oil, spray...).*/
+    DRY_MEDIUM,    /**< To simulate a dry medium such as Pencil or Charcoal. */
+    HUMID_MEDIUM,  /**< To simulate ink painting (color subtraction blending). */
+    OPAQUE_MEDIUM, /**< To simulate an opaque medium (oil, spray...). */
   } MediumType;
 
  public:
diff --git a/source/blender/freestyle/intern/view_map/Functions1D.h b/source/blender/freestyle/intern/view_map/Functions1D.h
index 532e89261ce..e45bc459bf0 100644
--- a/source/blender/freestyle/intern/view_map/Functions1D.h
+++ b/source/blender/freestyle/intern/view_map/Functions1D.h
@@ -328,7 +328,7 @@ class GetProjectedZF1D : public UnaryFunction1D<double> {
 };
 
 // Orientation2DF1D
-/** Returns the 2D orientation as a Vec2f*/
+/** Returns the 2D orientation as a #Vec2f. */
 class Orientation2DF1D : public UnaryFunction1D<Vec2f> {
  private:
   Functions0D::VertexOrientation2DF0D _func;
@@ -525,7 +525,7 @@ class Curvature2DAngleF1D : public UnaryFunction1D<double> {
     return "Curvature2DAngleF1D";
   }
 
-  /** the () operator.*/
+  /** the () operator. */
   int operator()(Interface1D &inter)
   {
     result = integrate(_fun, inter.verticesBegin(), inter.verticesEnd(), _integration);
@@ -554,7 +554,7 @@ class Normal2DF1D : public UnaryFunction1D<Vec2f> {
     return "Normal2DF1D";
   }
 
-  /** the () operator.*/
+  /** the () operator. */
   int operator()(Interface1D &inter)
   {
     result = integrate(_fun, inter.verticesBegin(), inter.verticesEnd(), _integration);
diff --git a/source/blender/freestyle/intern/view_map/Interface1D.h b/source/blender/freestyle/intern/view_map/Interface1D.h
index 8d1879af31b..75ad71a373d 100644
--- a/source/blender/freestyle/intern/view_map/Interface1D.h
+++ b/source/blender/freestyle/intern/view_map/Interface1D.h
@@ -46,15 +46,15 @@ namespace Freestyle {
  */
 typedef enum {
   MEAN, /**< The value computed for the 1D element is the mean of the values obtained for the 0D
-           elements.*/
+           elements. */
   MIN,  /**< The value computed for the 1D element is the minimum of the values obtained for the 0D
-           elements.*/
+           elements. */
   MAX,  /**< The value computed for the 1D element is the maximum of the values obtained for the 0D
-           elements.*/
+           elements. */
   FIRST, /**< The value computed for the 1D element is the first of the values obtained for the 0D
-            elements.*/
+            elements. */
   LAST,  /**< The value computed for the 1D element is the last of the values obtained for the 0D
-            elements.*/
+            elements. */
 } IntegrationType;
 
 /** Returns a single value from a set of values evaluated at each 0D element of this 1D element.
diff --git a/source/blender/freestyle/intern/view_map/Silhouette.h b/source/blender/freestyle/intern/view_map/Silhouette.h
index 10544f5e883..0ec9144595c 100644
--- a/source/blender/freestyle/intern/view_map/Silhouette.h
+++ b/source/blender/freestyle/intern/view_map/Silhouette.h
@@ -171,7 +171,7 @@ class SVertex : public Interface0D {
    */
   void *userdata;
 
-  /** Default constructor.*/
+  /** Default constructor. */
   inline SVertex()
   {
     _Id = 0;
@@ -326,7 +326,7 @@ class SVertex : public Interface0D {
   }
 
 #if 0
-  /* Fredo's normal and curvature*/
+  /* Fredo's normal and curvature. */
   void setCurvatureFredo(real c)
   {
     _curvatureFredo = c;
@@ -941,7 +941,7 @@ class FEdge : public Interface1D {
 
   inline Vec3r curvature2d_as_vector(int iCombination = 0) const;
 
-  /* angle in degrees*/
+  /* Angle in degrees. */
   inline real curvature2d_as_angle(int iCombination = 0) const;
 #endif
 
@@ -1259,13 +1259,13 @@ class FEdgeSharp : public FEdge {
     _bNormal = iNormal;
   }
 
-  /** Sets the index of the material lying on the right of the FEdge.*/
+  /** Sets the index of the material lying on the right of the FEdge. */
   inline void setaFrsMaterialIndex(unsigned i)
   {
     _aFrsMaterialIndex = i;
   }
 
-  /** Sets the index of the material lying on the left of the FEdge.*/
+  /** Sets the index of the material lying on the left of the FEdge. */
   inline void setbFrsMaterialIndex(unsigned i)
   {
     _bFrsMaterialIndex = i;
@@ -1917,19 +1917,19 @@ class SShape {
   }
 
   /* Modififers */
-  /** Sets the Id of the shape.*/
+  /** Sets the Id of the shape. */
   inline void setId(Id id)
   {
     _Id = id;
   }
 
-  /** Sets the name of the shape.*/
+  /** Sets the name of the shape. */
   inline void setName(const string &name)
   {
     _Name = name;
   }
 
-  /** Sets the library path of the shape.*/
+  /** Sets the library path of the shape. */
   inline void setLibraryPath(const string &path)
   {
     _LibraryPath = path;
diff --git a/source/blender/freestyle/intern/view_map/ViewEdgeXBuilder.cpp b/source/blender/freestyle/intern/view_map/ViewEdgeXBuilder.cpp
index 8d5955fc0ae..24c56572803 100644
--- a/source/blender/freestyle/intern/view_map/ViewEdgeXBuilder.cpp
+++ b/source/blender/freestyle/intern/view_map/ViewEdgeXBuilder.cpp
@@ -601,7 +601,7 @@ OWXEdge ViewEdgeXBuilder::FindNextWEdge(const OWXEdge &iEdge)
   }
 
   if (((WXVertex *)v)->isFeature()) {
-    return nullptr; /* XXX eeek? NULL? OWXEdge(NULL, true/false)?*/
+    return nullptr; /* XXX eeek? NULL? OWXEdge(NULL, true/false)? */
   }
 
   int faceMarks = retrieveFaceMarks(iEdge.e);
diff --git a/source/blender/freestyle/intern/view_map/ViewMap.h b/source/blender/freestyle/intern/view_map/ViewMap.h
index a3ef5eed6d8..bd7edad7642 100644
--- a/source/blender/freestyle/intern/view_map/ViewMap.h
+++ b/source/blender/freestyle/intern/view_map/ViewMap.h
@@ -56,7 +56,7 @@ class ViewEdge;
 class ViewShape;
 class TVertex;
 
-/** Class defining the ViewMap.*/
+/** Class defining the ViewMap. */
 class ViewMap {
  public:
   typedef vector<ViewEdge *> viewedges_container;
@@ -295,7 +295,7 @@ class ViewVertex : public Interface0D {
    */
   void *userdata;
 
-  /** Default constructor.*/
+  /** Default constructor. */
   inline ViewVertex()
   {
     userdata = NULL;
@@ -483,7 +483,7 @@ class TVertex : public ViewVertex {
       _sortedEdges;  // the list of the four ViewEdges, ordered in CCW order (in the image plan)
 
  public:
-  /** Default constructor.*/
+  /** Default constructor. */
   inline TVertex() : ViewVertex(Nature::T_VERTEX)
   {
     _FrontSVertex = NULL;
@@ -758,7 +758,7 @@ class NonTVertex : public ViewVertex {
   edges_container _ViewEdges;
 
  public:
-  /** Default constructor.*/
+  /** Default constructor. */
   inline NonTVertex() : ViewVertex(Nature::NON_T_VERTEX)
   {
     _SVertex = NULL;
@@ -1182,7 +1182,7 @@ class ViewEdge : public Interface1D {
     _FEdgeB = iFEdge;
   }
 
-  /** Sets the ViewShape to which this ViewEdge belongs to.*/
+  /** Sets the ViewShape to which this ViewEdge belongs to. */
   inline void setShape(ViewShape *iVShape)
   {
     _Shape = iVShape;
@@ -1417,7 +1417,7 @@ class ViewShape {
    */
   void *userdata;
 
-  /** Default constructor.*/
+  /** Default constructor. */
   inline ViewShape()
   {
     userdata = NULL;
diff --git a/source/blender/freestyle/intern/view_map/ViewMapIterators.h b/source/blender/freestyle/intern/view_map/ViewMapIterators.h
index 7f98c2745f4..1df78e71d9d 100644
--- a/source/blender/freestyle/intern/view_map/ViewMapIterators.h
+++ b/source/blender/freestyle/intern/view_map/ViewMapIterators.h
@@ -208,7 +208,7 @@ class orientedViewEdgeIterator : public Iterator {
   }
 
  public:
-  /** increments.*/
+  /** increments. */
   virtual inline int increment()
   {
     if (_Nature & Nature::T_VERTEX) {
diff --git a/source/blender/freestyle/intern/winged_edge/WEdge.h b/source/blender/freestyle/intern/winged_edge/WEdge.h
index 125dec27b8a..2a2c8754454 100644
--- a/source/blender/freestyle/intern/winged_edge/WEdge.h
+++ b/source/blender/freestyle/intern/winged_edge/WEdge.h
@@ -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
-- 
cgit v1.2.3