[Bf-blender-cvs] [1f778dbefca] master: Cleanup: use Blender's code style for doxygen commetns in freestyle
Campbell Barton
noreply at git.blender.org
Thu Jun 24 08:01:21 CEST 2021
Commit: 1f778dbefcaf825dcad1f70a9cc45e503ad74ed5
Author: Campbell Barton
Date: Thu Jun 24 15:57:33 2021 +1000
Branches: master
https://developer.blender.org/rB1f778dbefcaf825dcad1f70a9cc45e503ad74ed5
Cleanup: use Blender's code style for doxygen commetns in freestyle
===================================================================
M source/blender/freestyle/intern/application/AppCanvas.h
M source/blender/freestyle/intern/application/AppView.h
M source/blender/freestyle/intern/blender_interface/BlenderFileLoader.h
M source/blender/freestyle/intern/blender_interface/BlenderStrokeRenderer.h
M source/blender/freestyle/intern/geometry/FastGrid.h
M source/blender/freestyle/intern/geometry/FitCurve.h
M source/blender/freestyle/intern/geometry/GeomCleaner.cpp
M source/blender/freestyle/intern/geometry/GeomCleaner.h
M source/blender/freestyle/intern/geometry/GeomUtils.h
M source/blender/freestyle/intern/geometry/Grid.h
M source/blender/freestyle/intern/geometry/GridHelpers.h
M source/blender/freestyle/intern/geometry/HashGrid.h
M source/blender/freestyle/intern/geometry/Noise.h
M source/blender/freestyle/intern/geometry/Polygon.h
M source/blender/freestyle/intern/geometry/SweepLine.h
M source/blender/freestyle/intern/image/GaussianFilter.h
M source/blender/freestyle/intern/image/Image.h
M source/blender/freestyle/intern/image/ImagePyramid.h
M source/blender/freestyle/intern/scene_graph/DrawingStyle.h
M source/blender/freestyle/intern/scene_graph/FrsMaterial.h
M source/blender/freestyle/intern/scene_graph/IndexedFaceSet.h
M source/blender/freestyle/intern/scene_graph/LineRep.h
M source/blender/freestyle/intern/scene_graph/Node.h
M source/blender/freestyle/intern/scene_graph/NodeCamera.h
M source/blender/freestyle/intern/scene_graph/NodeDrawingStyle.h
M source/blender/freestyle/intern/scene_graph/NodeGroup.cpp
M source/blender/freestyle/intern/scene_graph/NodeGroup.h
M source/blender/freestyle/intern/scene_graph/NodeLight.h
M source/blender/freestyle/intern/scene_graph/NodeShape.h
M source/blender/freestyle/intern/scene_graph/NodeTransform.h
M source/blender/freestyle/intern/scene_graph/NodeViewLayer.h
M source/blender/freestyle/intern/scene_graph/OrientedLineRep.h
M source/blender/freestyle/intern/scene_graph/Rep.h
M source/blender/freestyle/intern/scene_graph/TriangleRep.h
M source/blender/freestyle/intern/scene_graph/VertexRep.h
M source/blender/freestyle/intern/stroke/AdvancedFunctions0D.h
M source/blender/freestyle/intern/stroke/AdvancedFunctions1D.h
M source/blender/freestyle/intern/stroke/AdvancedPredicates1D.h
M source/blender/freestyle/intern/stroke/AdvancedStrokeShaders.h
M source/blender/freestyle/intern/stroke/BasicStrokeShaders.h
M source/blender/freestyle/intern/stroke/Canvas.h
M source/blender/freestyle/intern/stroke/Chain.h
M source/blender/freestyle/intern/stroke/ChainingIterators.h
M source/blender/freestyle/intern/stroke/ContextFunctions.h
M source/blender/freestyle/intern/stroke/Curve.cpp
M source/blender/freestyle/intern/stroke/Curve.h
M source/blender/freestyle/intern/stroke/CurveAdvancedIterators.h
M source/blender/freestyle/intern/stroke/CurveIterators.h
M source/blender/freestyle/intern/stroke/Modifiers.h
M source/blender/freestyle/intern/stroke/Operators.h
M source/blender/freestyle/intern/stroke/PSStrokeRenderer.h
M source/blender/freestyle/intern/stroke/Predicates0D.h
M source/blender/freestyle/intern/stroke/Predicates1D.h
M source/blender/freestyle/intern/stroke/Stroke.h
M source/blender/freestyle/intern/stroke/StrokeAdvancedIterators.h
M source/blender/freestyle/intern/stroke/StrokeIterators.h
M source/blender/freestyle/intern/stroke/StrokeLayer.h
M source/blender/freestyle/intern/stroke/StrokeRenderer.h
M source/blender/freestyle/intern/stroke/StrokeRep.h
M source/blender/freestyle/intern/stroke/StrokeShader.h
M source/blender/freestyle/intern/stroke/StrokeTesselator.h
M source/blender/freestyle/intern/stroke/TextStrokeRenderer.h
M source/blender/freestyle/intern/system/BaseObject.h
M source/blender/freestyle/intern/system/Id.h
M source/blender/freestyle/intern/system/ProgressBar.h
M source/blender/freestyle/intern/view_map/FEdgeXDetector.h
M source/blender/freestyle/intern/view_map/Functions0D.h
M source/blender/freestyle/intern/view_map/Functions1D.h
M source/blender/freestyle/intern/view_map/Interface0D.h
M source/blender/freestyle/intern/view_map/Interface1D.h
M source/blender/freestyle/intern/view_map/Silhouette.h
M source/blender/freestyle/intern/view_map/SilhouetteGeomEngine.h
M source/blender/freestyle/intern/view_map/SphericalGrid.h
M source/blender/freestyle/intern/view_map/SteerableViewMap.h
M source/blender/freestyle/intern/view_map/ViewEdgeXBuilder.h
M source/blender/freestyle/intern/view_map/ViewMap.cpp
M source/blender/freestyle/intern/view_map/ViewMap.h
M source/blender/freestyle/intern/view_map/ViewMapAdvancedIterators.h
M source/blender/freestyle/intern/view_map/ViewMapBuilder.h
M source/blender/freestyle/intern/view_map/ViewMapIterators.h
M source/blender/freestyle/intern/view_map/ViewMapTesselator.h
M source/blender/freestyle/intern/winged_edge/Curvature.cpp
M source/blender/freestyle/intern/winged_edge/Nature.h
M source/blender/freestyle/intern/winged_edge/WEdge.cpp
M source/blender/freestyle/intern/winged_edge/WEdge.h
M source/blender/freestyle/intern/winged_edge/WFillGrid.h
M source/blender/freestyle/intern/winged_edge/WSFillGrid.h
M source/blender/freestyle/intern/winged_edge/WXEdge.h
===================================================================
diff --git a/source/blender/freestyle/intern/application/AppCanvas.h b/source/blender/freestyle/intern/application/AppCanvas.h
index 1ff7e781ce6..8329192e6d6 100644
--- a/source/blender/freestyle/intern/application/AppCanvas.h
+++ b/source/blender/freestyle/intern/application/AppCanvas.h
@@ -32,21 +32,21 @@ class AppCanvas : public Canvas {
AppCanvas(const AppCanvas &iBrother);
virtual ~AppCanvas();
- /*! operations that need to be done before a draw */
+ /** operations that need to be done before a draw */
virtual void preDraw();
- /*! operations that need to be done after a draw */
+ /** operations that need to be done after a draw */
virtual void postDraw();
- /*! Erases the layers and clears the canvas */
+ /** Erases the layers and clears the canvas */
virtual void Erase();
/* init the canvas */
virtual void init();
- /*! Reads a pixel area from the canvas */
+ /** Reads a pixel area from the canvas */
virtual void readColorPixels(int x, int y, int w, int h, RGBImage &oImage) const;
- /*! Reads a depth pixel area from the canvas */
+ /** Reads a depth pixel area from the canvas */
virtual void readDepthPixels(int x, int y, int w, int h, GrayImage &oImage) const;
virtual BBox<Vec3r> scene3DBBox() const;
@@ -55,7 +55,7 @@ class AppCanvas : public Canvas {
virtual void RenderStroke(Stroke *);
virtual void update();
- /*! accessors */
+ /** accessors */
virtual int width() const;
virtual int height() const;
virtual BBox<Vec2i> border() const;
@@ -67,7 +67,7 @@ class AppCanvas : public Canvas {
return _pViewer;
}
- /*! modifiers */
+ /** modifiers */
void setViewer(AppView *iViewer);
/* soc */
diff --git a/source/blender/freestyle/intern/application/AppView.h b/source/blender/freestyle/intern/application/AppView.h
index 3f07d2794c4..ccb2c61fef5 100644
--- a/source/blender/freestyle/intern/application/AppView.h
+++ b/source/blender/freestyle/intern/application/AppView.h
@@ -83,7 +83,7 @@ class AppView {
float _thickness;
public:
- /*! Sets the model to draw in the viewer
+ /** Sets the model to draw in the viewer
* iModel
* The Root Node of the model
*/
@@ -97,7 +97,7 @@ class AppView {
AddModel(iModel);
}
- /*! Adds a model for displaying in the viewer */
+ /** Adds a model for displaying in the viewer */
inline void AddModel(NodeGroup *iModel)
{
_ModelRootNode->AddChild(iModel);
@@ -226,14 +226,14 @@ class AppView {
real zfar();
public:
- /*! Core scene drawing */
+ /** Core scene drawing */
void DrawScene(SceneVisitor *iRenderer);
- /*! 2D Scene Drawing */
+ /** 2D Scene Drawing */
void Draw2DScene(SceneVisitor *iRenderer);
protected:
- /*! fabs or abs */
+ /** fabs or abs */
inline int rabs(int x)
{
return abs(x);
diff --git a/source/blender/freestyle/intern/blender_interface/BlenderFileLoader.h b/source/blender/freestyle/intern/blender_interface/BlenderFileLoader.h
index 1be2fc3bc99..8fbda2b55f4 100644
--- a/source/blender/freestyle/intern/blender_interface/BlenderFileLoader.h
+++ b/source/blender/freestyle/intern/blender_interface/BlenderFileLoader.h
@@ -80,28 +80,28 @@ struct LoaderState {
class BlenderFileLoader {
public:
- /*! Builds a MaxFileLoader */
+ /** Builds a MaxFileLoader */
BlenderFileLoader(Render *re, ViewLayer *view_layer, Depsgraph *depsgraph);
virtual ~BlenderFileLoader();
- /*! Loads the 3D scene and returns a pointer to the scene root node */
+ /** Loads the 3D scene and returns a pointer to the scene root node */
NodeGroup *Load();
- /*! Gets the number of read faces */
+ /** Gets the number of read faces */
inline unsigned int numFacesRead()
{
return _numFacesRead;
}
#if 0
- /*! Gets the smallest edge size read */
+ /** Gets the smallest edge size read */
inline real minEdgeSize()
{
return _minEdgeSize;
}
#endif
- /*! Modifiers */
+ /** Modifiers */
inline void setRenderMonitor(RenderMonitor *iRenderMonitor)
{
_pRenderMonitor = iRenderMonitor;
diff --git a/source/blender/freestyle/intern/blender_interface/BlenderStrokeRenderer.h b/source/blender/freestyle/intern/blender_interface/BlenderStrokeRenderer.h
index 1b2e57529d6..beee7453b4c 100644
--- a/source/blender/freestyle/intern/blender_interface/BlenderStrokeRenderer.h
+++ b/source/blender/freestyle/intern/blender_interface/BlenderStrokeRenderer.h
@@ -44,7 +44,7 @@ class BlenderStrokeRenderer : public StrokeRenderer {
BlenderStrokeRenderer(Render *re, int render_count);
virtual ~BlenderStrokeRenderer();
- /*! Renders a stroke rep */
+ /** Renders a stroke rep */
virtual void RenderStrokeRep(StrokeRep *iStrokeRep) const;
virtual void RenderStrokeRepBasic(StrokeRep *iStrokeRep) const;
diff --git a/source/blender/freestyle/intern/geometry/FastGrid.h b/source/blender/freestyle/intern/geometry/FastGrid.h
index ec47f36d644..524725d5464 100644
--- a/source/blender/freestyle/intern/geometry/FastGrid.h
+++ b/source/blender/freestyle/intern/geometry/FastGrid.h
@@ -25,7 +25,7 @@
namespace Freestyle {
-/*! Class to define a regular grid used for ray casting computations
+/** Class to define a regular grid used for ray casting computations
* We don't use a hashtable here. The grid is explicitly stored for faster computations.
* However, this might result in significant increase in memory usage
* (compared to the regular grid).
@@ -43,13 +43,13 @@ class FastGrid : public Grid {
clear();
}
- /*!
+ /**
* clears the grid
* Deletes all the cells, clears the hashtable, resets size, size of cell, number of cells.
*/
virtual void clear();
- /*! Sets the different parameters of the grid
+ /** Sets the different parameters of the grid
* orig
* The grid origin
* size
@@ -59,10 +59,10 @@ class FastGrid : public Grid {
*/
virtual void configure(const Vec3r &orig, const Vec3r &size, unsigned nb);
- /*! returns the cell whose coordinates are passed as argument */
+ /** returns the cell whose coordinates are passed as argument */
Cell *getCell(const Vec3u &p);
- /*! Fills the case p with the cell iCell */
+ /** Fills the case p with the cell iCell */
virtual void fillCell(const Vec3u &p, Cell &cell);
protected:
diff --git a/source/blender/freestyle/intern/geometry/FitCurve.h b/source/blender/freestyle/intern/geometry/FitCurve.h
index dc60d67b943..3e99893d66f 100644
--- a/source/blender/freestyle/intern/geometry/FitCurve.h
+++ b/source/blender/freestyle/intern/geometry/FitCurve.h
@@ -72,7 +72,7 @@ class FitCurveWrapper {
public:
~FitCurveWrapper();
- /*! Fits a set of 2D data points to a set of Bezier Curve segments
+ /** Fits a set of 2D data points to a set of Bezier Curve segments
* data
* Input data points
* oCurve
@@ -90,7 +90,7 @@ class FitCurveWrapper {
*/
void FitCurve(Vector2 *d, int nPts, double error);
- /*! Draws a Bezier curve segment
+ /** Draws a Bezier curve segment
* n
* degree of curve (=3)
* curve
diff --git a/source/blender/freestyle/intern/geometry/GeomCleaner.cpp b/source/blender/freestyle/intern/geometry/GeomCleaner.cpp
index 7ec18fb2801..349347c1862 100644
--- a/source/blender/freestyle/intern/geometry/GeomCleaner.cpp
+++ b/source/blender/freestyle/intern/geometry/GeomCleaner.cpp
@@ -180,7 +180,7 @@ void GeomCleaner::SortAndCompressIndexedVertexArray(const float *iVertices,
delete[] tmpIndices;
}
-/*! Defines a hash table used for searching the Cells */
+/** Defines a hash table used for searching the Cells */
struct GeomCleanerHasher {
#define _MUL 950706376UL
#define _MOD 2147483647UL
diff --git a/source/blender/freestyle/intern/geometry/GeomCleaner.h b/source/blender/freestyle/intern/geometry/GeomCleaner.h
index 7abbf881548..6ad1f040972 100644
--- a/source/blender/freestyle/intern/geometry/GeomCleaner.h
+++ b/source/blender/freestyle/intern/geometry/GeomCleaner.h
@@ -42,7 +42,7 @@ class GeomCleaner {
{
}
- /*! Sorts an array of Indexed vertices
+ /** Sorts an array of Indexed vertices
* iVertices
* Array of vertices to sort.
* It is organized as a float series of vertex coordinates: XYZXYZXYZ...
@@ -70,7 +70,7 @@ class GeomCleaner {
float **oVertices,
unsigned **oIndices);
- /*! Compress a SORTED indexed vertex array by eliminating multiple
+ /** Compress a SORTED indexed vertex array by eliminating multiple
* appearing occurrences of a single vertex.
* iVertices
* The SORTED vertex array to compress.
@@ -99,7 +99,7 @@ class GeomCleaner {
unsigned *oVSize,
unsigned **oIndices);
- /*! Sorts and compress an array of indexed vertices.
+ /** Sorts and compress an array of indexed vertices.
* iVertices
* The vertex array to sort then compress. It is organized as a float series of
* vertex coordinates: XYZXYZXYZ...
@@ -127,7 +127,7 @@ class GeomCleaner {
unsigned *oVSize,
unsigned **oIndices);
- /*! Cleans an indexed vertex array.
+ /** Cleans an indexed vertex array.
* (Identical to SortAndCompress except that we use here a hash table to create the new array.)
* iVertices
* The vertex array to sort then compress. It is organized as a float series of
@@ -161,10 +161,10 @@ class GeomCleaner {
#endif
};
-/*! Binary operators */
+/** Binary operators */
// inline bool operator<(const IndexedVertex& iv1, const IndexedVertex& iv2);
-/*! Class Indexed Vertex. Used to represent an indexed vertex by storing the vertex coordinates as
+/** Class Indexed Vertex. Used to represent an indexed vertex by storing the vertex coordinates as
* well as its index */
class IndexedVertex {
private:
@@ -182,7 +182,7 @@ class IndexedVertex {
_index = iIndex;
}
- /*! accessors */
+ /** accessors */
inline const Vec3f &vector() const
{
return _Vector;
@@ -208,7 +208,7 @@ class Indexed
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list