From 9b89de2571b0c3fa2276b5c2ae589e0ec831d1f5 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Sat, 3 Jul 2021 23:08:40 +1000 Subject: Cleanup: consistent use of tags: NOTE/TODO/FIXME/XXX Also use doxy style function reference `#` prefix chars when referencing identifiers. --- source/blender/freestyle/intern/application/AppView.h | 2 +- .../blender/freestyle/intern/blender_interface/BlenderFileLoader.cpp | 2 +- .../freestyle/intern/blender_interface/BlenderStrokeRenderer.cpp | 2 +- source/blender/freestyle/intern/geometry/normal_cycle.h | 2 +- source/blender/freestyle/intern/python/BPy_FrsNoise.cpp | 2 +- .../freestyle/intern/python/Interface0D/ViewVertex/BPy_NonTVertex.cpp | 2 +- .../freestyle/intern/python/Interface0D/ViewVertex/BPy_TVertex.cpp | 2 +- source/blender/freestyle/intern/system/FreestyleConfig.h | 2 +- source/blender/freestyle/intern/system/RandGen.h | 2 +- source/blender/freestyle/intern/view_map/ViewMapIO.cpp | 2 +- source/blender/freestyle/intern/winged_edge/Curvature.cpp | 4 ++-- source/blender/freestyle/intern/winged_edge/WXEdge.cpp | 4 ++-- source/blender/freestyle/intern/winged_edge/WXEdge.h | 4 ++-- 13 files changed, 16 insertions(+), 16 deletions(-) (limited to 'source/blender/freestyle') diff --git a/source/blender/freestyle/intern/application/AppView.h b/source/blender/freestyle/intern/application/AppView.h index ccb2c61fef5..c8ecbc9eadc 100644 --- a/source/blender/freestyle/intern/application/AppView.h +++ b/source/blender/freestyle/intern/application/AppView.h @@ -214,7 +214,7 @@ class AppView { inline real GetFovyDegrees() const { - return _Fovy * 180.0 / M_PI; // TODO Use RAD2DEG here too? + return _Fovy * 180.0 / M_PI; // TODO: Use RAD2DEG here too? } BBox scene3DBBox() const diff --git a/source/blender/freestyle/intern/blender_interface/BlenderFileLoader.cpp b/source/blender/freestyle/intern/blender_interface/BlenderFileLoader.cpp index a16479873e7..9c3270e788c 100644 --- a/source/blender/freestyle/intern/blender_interface/BlenderFileLoader.cpp +++ b/source/blender/freestyle/intern/blender_interface/BlenderFileLoader.cpp @@ -435,7 +435,7 @@ void BlenderFileLoader::insertShapeNode(Object *ob, Mesh *me, int id) transpose_m4(nmat); // We count the number of triangles after the clipping by the near and far view - // planes is applied (Note: mesh vertices are in the camera coordinate system). + // planes is applied (NOTE: mesh vertices are in the camera coordinate system). unsigned numFaces = 0; float v1[3], v2[3], v3[3]; float n1[3], n2[3], n3[3], facenormal[3]; diff --git a/source/blender/freestyle/intern/blender_interface/BlenderStrokeRenderer.cpp b/source/blender/freestyle/intern/blender_interface/BlenderStrokeRenderer.cpp index 4f6ffc451c8..e290b8a87a3 100644 --- a/source/blender/freestyle/intern/blender_interface/BlenderStrokeRenderer.cpp +++ b/source/blender/freestyle/intern/blender_interface/BlenderStrokeRenderer.cpp @@ -671,7 +671,7 @@ void BlenderStrokeRenderer::GenerateStrokeMesh(StrokeGroup *group, bool hasTex) visible = false; - // Note: Mesh generation in the following loop assumes stroke strips + // NOTE: Mesh generation in the following loop assumes stroke strips // to be triangle strips. for (int n = 2; n < strip_vertex_count; n++, v[0]++, v[1]++, v[2]++) { svRep[0] = *(v[0]); diff --git a/source/blender/freestyle/intern/geometry/normal_cycle.h b/source/blender/freestyle/intern/geometry/normal_cycle.h index 9d8ffcfd7fb..949675e9d8d 100644 --- a/source/blender/freestyle/intern/geometry/normal_cycle.h +++ b/source/blender/freestyle/intern/geometry/normal_cycle.h @@ -67,7 +67,7 @@ class NormalCycle { void begin(); void end(); /** - * Note: the specified edge vector needs to be pre-clipped by the neighborhood. + * NOTE: the specified edge vector needs to be pre-clipped by the neighborhood. */ void accumulate_dihedral_angle(const Vec3r &edge, real angle, real neigh_area = 1.0); diff --git a/source/blender/freestyle/intern/python/BPy_FrsNoise.cpp b/source/blender/freestyle/intern/python/BPy_FrsNoise.cpp index 4c339a54bb3..959c5ec7074 100644 --- a/source/blender/freestyle/intern/python/BPy_FrsNoise.cpp +++ b/source/blender/freestyle/intern/python/BPy_FrsNoise.cpp @@ -122,7 +122,7 @@ static PyObject *FrsNoise_turbulence_smooth(BPy_FrsNoise *self, PyObject *args, { static const char *kwlist[] = {"v", "oct", nullptr}; - double x; // note: this has to be a double (not float) + double x; // NOTE: this has to be a double (not float) unsigned nbOctaves = 8; if (!PyArg_ParseTupleAndKeywords(args, kwds, "d|I", (char **)kwlist, &x, &nbOctaves)) { diff --git a/source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_NonTVertex.cpp b/source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_NonTVertex.cpp index 3c0ee9fd9a3..f63ad0d618b 100644 --- a/source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_NonTVertex.cpp +++ b/source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_NonTVertex.cpp @@ -48,7 +48,7 @@ PyDoc_STRVAR( " :arg svertex: An SVertex object.\n" " :type svertex: :class:`SVertex`"); -/* Note: No copy constructor in Python because the C++ copy constructor is 'protected'. */ +/* NOTE: No copy constructor in Python because the C++ copy constructor is 'protected'. */ static int NonTVertex_init(BPy_NonTVertex *self, PyObject *args, PyObject *kwds) { diff --git a/source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_TVertex.cpp b/source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_TVertex.cpp index 9fe39b3e359..0e6d6766436 100644 --- a/source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_TVertex.cpp +++ b/source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_TVertex.cpp @@ -49,7 +49,7 @@ PyDoc_STRVAR(TVertex_doc, "\n" " Default constructor."); -/* Note: No copy constructor in Python because the C++ copy constructor is 'protected'. */ +/* NOTE: No copy constructor in Python because the C++ copy constructor is 'protected'. */ static int TVertex_init(BPy_TVertex *self, PyObject *args, PyObject *kwds) { diff --git a/source/blender/freestyle/intern/system/FreestyleConfig.h b/source/blender/freestyle/intern/system/FreestyleConfig.h index 032da864e6c..92c207a1b7f 100644 --- a/source/blender/freestyle/intern/system/FreestyleConfig.h +++ b/source/blender/freestyle/intern/system/FreestyleConfig.h @@ -30,7 +30,7 @@ namespace Freestyle { namespace Config { // Directory separators -// TODO Use Blender's stuff for such things! +// TODO: Use Blender's stuff for such things! #ifdef WIN32 static const string DIR_SEP("\\"); static const string PATH_SEP(";"); diff --git a/source/blender/freestyle/intern/system/RandGen.h b/source/blender/freestyle/intern/system/RandGen.h index f54a0035b62..9d9697a2d34 100644 --- a/source/blender/freestyle/intern/system/RandGen.h +++ b/source/blender/freestyle/intern/system/RandGen.h @@ -21,7 +21,7 @@ * \brief Pseudo-random number generator */ -// TODO Check whether we could replace this with BLI rand stuff... +// TODO: Check whether we could replace this with BLI rand stuff... #include "../system/Precision.h" diff --git a/source/blender/freestyle/intern/view_map/ViewMapIO.cpp b/source/blender/freestyle/intern/view_map/ViewMapIO.cpp index 774751a2589..7cb06673811 100644 --- a/source/blender/freestyle/intern/view_map/ViewMapIO.cpp +++ b/source/blender/freestyle/intern/view_map/ViewMapIO.cpp @@ -813,7 +813,7 @@ static int save(ostream &out, SVertex *sv) WRITE_IF_NON_NULL(sv->viewvertex()); // Normals (List) - // Note: the 'size()' method of a set doesn't seem to return the actual size of the given set, so + // NOTE: the 'size()' method of a set doesn't seem to return the actual size of the given set, so // we have to hack it... set::const_iterator i; for (i = sv->normals().begin(), tmp = 0; i != sv->normals().end(); i++, tmp++) { diff --git a/source/blender/freestyle/intern/winged_edge/Curvature.cpp b/source/blender/freestyle/intern/winged_edge/Curvature.cpp index 62d767fd2a1..478e48de66c 100644 --- a/source/blender/freestyle/intern/winged_edge/Curvature.cpp +++ b/source/blender/freestyle/intern/winged_edge/Curvature.cpp @@ -98,7 +98,7 @@ static real angle_from_cotan(WVertex *vo, WVertex *v1, WVertex *v2) udotv = u * v; denom = sqrt(u.squareNorm() * v.squareNorm() - udotv * udotv); - /* Note: I assume this is what they mean by using atan2(). -Ray Jones */ + /* NOTE(Ray Jones): I assume this is what they mean by using #atan2. */ /* tan = denom/udotv = y/x (see man page for atan2) */ return (fabs(atan2(denom, udotv))); @@ -112,7 +112,7 @@ static real angle_from_cotan(WVertex *vo, WVertex *v1, WVertex *v2) * Computes the Discrete Mean Curvature Normal approximation at \a v. * The mean curvature at \a v is half the magnitude of the vector \a Kh. * - * Note: the normal computed is not unit length, and may point either into or out of the surface, + * NOTE: the normal computed is not unit length, and may point either into or out of the surface, * depending on the curvature at \a v. It is the responsibility of the caller of the function to * use the mean curvature normal appropriately. * diff --git a/source/blender/freestyle/intern/winged_edge/WXEdge.cpp b/source/blender/freestyle/intern/winged_edge/WXEdge.cpp index bedf4192d64..cef1a8f8f77 100644 --- a/source/blender/freestyle/intern/winged_edge/WXEdge.cpp +++ b/source/blender/freestyle/intern/winged_edge/WXEdge.cpp @@ -37,7 +37,7 @@ unsigned int WXFaceLayer::Get0VertexIndex() const int i = 0; int nEdges = _pWXFace->numberOfEdges(); for (i = 0; i < nEdges; ++i) { - if (_DotP[i] == 0.0f) { // TODO this comparison is weak, check if it actually works + if (_DotP[i] == 0.0f) { // TODO: this comparison is weak, check if it actually works return i; } } @@ -48,7 +48,7 @@ unsigned int WXFaceLayer::GetSmoothEdgeIndex() const int i = 0; int nEdges = _pWXFace->numberOfEdges(); for (i = 0; i < nEdges; ++i) { - if ((_DotP[i] == 0.0f) && (_DotP[(i + 1) % nEdges] == 0.0f)) { // TODO ditto + if ((_DotP[i] == 0.0f) && (_DotP[(i + 1) % nEdges] == 0.0f)) { // TODO: ditto return i; } } diff --git a/source/blender/freestyle/intern/winged_edge/WXEdge.h b/source/blender/freestyle/intern/winged_edge/WXEdge.h index f95913c23f3..b335a364365 100644 --- a/source/blender/freestyle/intern/winged_edge/WXEdge.h +++ b/source/blender/freestyle/intern/winged_edge/WXEdge.h @@ -465,7 +465,7 @@ class WXFaceLayer { if (iDotP > 0.0f) { ++_nPosDotP; } - if (iDotP == 0.0f) { // TODO this comparison is weak, check if it actually works + if (iDotP == 0.0f) { // TODO: this comparison is weak, check if it actually works ++_nNullDotP; } } @@ -484,7 +484,7 @@ class WXFaceLayer { if ((*d) > 0.0f) { ++_nPosDotP; } - if ((*d) == 0.0f) { // TODO ditto + if ((*d) == 0.0f) { // TODO: ditto ++_nNullDotP; } } -- cgit v1.2.3