Cleanup: use C comments for descriptive text

19 files changed, 63 insertions, 67 deletions

diff --git a/intern/ghost/intern/GHOST_ContextGLX.cpp b/intern/ghost/intern/GHOST_ContextGLX.cpp
index eb49dc4f98b..78c7201ff5f 100644
--- a/intern/ghost/intern/GHOST_ContextGLX.cpp
+++ b/intern/ghost/intern/GHOST_ContextGLX.cpp
@@ -295,8 +295,8 @@ GHOST_TSuccess GHOST_ContextGLX::initializeDrawingContext()
 
     glXMakeCurrent(m_display, m_window, m_context);
 
-    // Seems that this has to be called after MakeCurrent,
-    // which means we cannot use glX extensions until after we create a context
+    /* Seems that this has to be called after #glXMakeCurrent,
+     * which means we cannot use `glX` extensions until after we create a context. */
     initContextGLXEW();
 
     if (m_window) {
diff --git a/intern/ghost/intern/GHOST_SystemX11.cpp b/intern/ghost/intern/GHOST_SystemX11.cpp
index 9fcad8aabf7..9422d15692d 100644
--- a/intern/ghost/intern/GHOST_SystemX11.cpp
+++ b/intern/ghost/intern/GHOST_SystemX11.cpp
@@ -802,8 +802,7 @@ static bool checkTabletProximity(Display *display, XDevice *device)
 
   if (state) {
     XInputClass *cls = state->data;
-    // printf("%d class%s :\n", state->num_classes,
-    //       (state->num_classes > 1) ? "es" : "");
+    // printf("%d class%s :\n", state->num_classes, (state->num_classes > 1) ? "es" : "");
     for (int loop = 0; loop < state->num_classes; loop++) {
       switch (cls->c_class) {
         case ValuatorClass:
diff --git a/intern/ghost/intern/GHOST_WindowX11.cpp b/intern/ghost/intern/GHOST_WindowX11.cpp
index 185d12717e7..de389951613 100644
--- a/intern/ghost/intern/GHOST_WindowX11.cpp
+++ b/intern/ghost/intern/GHOST_WindowX11.cpp
@@ -1275,15 +1275,15 @@ GHOST_Context *GHOST_WindowX11::newDrawingContext(GHOST_TDrawingContextType type
 {
   if (type == GHOST_kDrawingContextTypeOpenGL) {
 
-    // During development:
-    //   try 4.x compatibility profile
-    //   try 3.3 compatibility profile
-    //   fall back to 3.0 if needed
-    //
-    // Final Blender 2.8:
-    //   try 4.x core profile
-    //   try 3.3 core profile
-    //   no fallbacks
+    /* During development:
+     * - Try 4.x compatibility profile.
+     * - Try 3.3 compatibility profile.
+     * - Fall back to 3.0 if needed.
+     *
+     * Final Blender 2.8:
+     * - Try 4.x core profile
+     * - Try 3.3 core profile
+     * - No fall-backs. */
 
 #if defined(WITH_GL_PROFILE_CORE)
     {
diff --git a/source/blender/blenkernel/intern/armature_test.cc b/source/blender/blenkernel/intern/armature_test.cc
index 47853deec3e..99eb064d061 100644
--- a/source/blender/blenkernel/intern/armature_test.cc
+++ b/source/blender/blenkernel/intern/armature_test.cc
@@ -180,7 +180,7 @@ class BKE_armature_find_selected_bones_test : public testing::Test {
     BLI_addtail(&arm.bonebase, &bone2);     // bone2 is root bone
     BLI_addtail(&bone2.childbase, &bone3);  // bone3 has bone2 as parent
 
-    // Make sure the armature & its bones are visible, to make them selectable.
+    /* Make sure the armature & its bones are visible, to make them selectable. */
     arm.layer = bone1.layer = bone2.layer = bone3.layer = 1;
   }
 };
@@ -200,8 +200,8 @@ TEST_F(BKE_armature_find_selected_bones_test, some_bones_selected)
   EXPECT_EQ(seen_bones[0], &bone1);
   EXPECT_EQ(seen_bones[1], &bone3);
 
-  EXPECT_FALSE(result.all_bones_selected);  // Bone 2 was not selected.
-  EXPECT_FALSE(result.no_bones_selected);   // Bones 1 and 3 were selected.
+  EXPECT_FALSE(result.all_bones_selected); /* Bone 2 was not selected. */
+  EXPECT_FALSE(result.no_bones_selected);  /* Bones 1 and 3 were selected. */
 }
 
 TEST_F(BKE_armature_find_selected_bones_test, no_bones_selected)
diff --git a/source/blender/blenkernel/intern/softbody.c b/source/blender/blenkernel/intern/softbody.c
index 1a408aceeb2..f41251f6ea5 100644
--- a/source/blender/blenkernel/intern/softbody.c
+++ b/source/blender/blenkernel/intern/softbody.c
@@ -3447,10 +3447,10 @@ static void softbody_step(
         float newtime = forcetime * 1.1f; /* hope for 1.1 times better conditions in next step */
 
         if (sb->scratch->flag & SBF_DOFUZZY) {
-          ///* stay with this stepsize unless err really small */
+          // /* stay with this stepsize unless err really small */
           // if (err > SoftHeunTol/(2.0f*sb->fuzzyness)) {
           newtime = forcetime;
-          //}
+          // }
         }
         else {
           if (err > SoftHeunTol / 2.0f) { /* stay with this stepsize unless err really small */
diff --git a/source/blender/blenkernel/intern/text.c b/source/blender/blenkernel/intern/text.c
index 80ff8ce9162..6048e823abb 100644
--- a/source/blender/blenkernel/intern/text.c
+++ b/source/blender/blenkernel/intern/text.c
@@ -2331,7 +2331,7 @@ int txt_setcurr_tab_spaces(Text *text, int space)
   }
 
   while (text->curl->line[i] == indent) {
-    // we only count those tabs/spaces that are before any text or before the curs;
+    /* We only count those tabs/spaces that are before any text or before the curs; */
     if (i == text->curc) {
       return i;
     }
diff --git a/source/blender/blenlib/BLI_winstuff.h b/source/blender/blenlib/BLI_winstuff.h
index 0953e3f1946..bf09b56c779 100644
--- a/source/blender/blenlib/BLI_winstuff.h
+++ b/source/blender/blenlib/BLI_winstuff.h
@@ -45,7 +45,7 @@
 
 #undef small
 
-// These definitions are also in BLI_math for simplicity
+/* These definitions are also in BLI_math for simplicity. */
 
 #ifdef __cplusplus
 extern "C" {
@@ -72,7 +72,7 @@ extern "C" {
 #if defined(_MSC_VER)
 #  define R_OK 4
 #  define W_OK 2
-// not accepted by access() on windows
+/* Not accepted by `access()` on windows. */
 //#  define X_OK    1
 #  define F_OK 0
 #endif
diff --git a/source/blender/blenlib/intern/path_util.c b/source/blender/blenlib/intern/path_util.c
index 99fae1f1616..4d0678035ba 100644
--- a/source/blender/blenlib/intern/path_util.c
+++ b/source/blender/blenlib/intern/path_util.c
@@ -1102,12 +1102,9 @@ bool BLI_path_abs(char *path, const char *basepath)
   }
 
 #ifdef WIN32
-  /* skip first two chars, which in case of
-   * absolute path will be drive:/blabla and
-   * in case of relpath //blabla/. So relpath
-   * // will be retained, rest will be nice and
-   * shiny win32 backward slashes :) -jesterKing
-   */
+  /* NOTE(@jesterking): Skip first two chars, which in case of absolute path will
+   * be `drive:/blabla` and in case of `relpath` `//blabla/`.
+   * So `relpath` `//` will be retained, rest will be nice and shiny WIN32 backward slashes. */
   BLI_str_replace_char(path + 2, '/', '\\');
 #endif
 
diff --git a/source/blender/blenloader/intern/versioning_290.c b/source/blender/blenloader/intern/versioning_290.c
index 09d43676b8f..7f7a2d97cbb 100644
--- a/source/blender/blenloader/intern/versioning_290.c
+++ b/source/blender/blenloader/intern/versioning_290.c
@@ -170,7 +170,7 @@ static void seq_convert_transform_crop(const Scene *scene,
   int image_size_x = scene->r.xsch;
   int image_size_y = scene->r.ysch;
 
-  /* Hardcoded legacy bit-flags which has been removed. */
+  /* Hard-coded legacy bit-flags which has been removed. */
   const uint32_t use_transform_flag = (1 << 16);
   const uint32_t use_crop_flag = (1 << 17);
 
diff --git a/source/blender/compositor/nodes/COM_MaskNode.cc b/source/blender/compositor/nodes/COM_MaskNode.cc
index ef171c01653..b5b23798160 100644
--- a/source/blender/compositor/nodes/COM_MaskNode.cc
+++ b/source/blender/compositor/nodes/COM_MaskNode.cc
@@ -41,7 +41,7 @@ void MaskNode::convertToOperations(NodeConverter &converter,
   NodeMask *data = (NodeMask *)editorNode->storage;
   Mask *mask = (Mask *)editorNode->id;
 
-  // always connect the output image
+  /* Always connect the output image. */
   MaskOperation *operation = new MaskOperation();
 
   if (editorNode->custom1 & CMP_NODEFLAG_MASK_FIXED) {
diff --git a/source/blender/compositor/nodes/COM_MovieClipNode.cc b/source/blender/compositor/nodes/COM_MovieClipNode.cc
index 50bd9b4d71b..b80071d27c7 100644
--- a/source/blender/compositor/nodes/COM_MovieClipNode.cc
+++ b/source/blender/compositor/nodes/COM_MovieClipNode.cc
@@ -62,7 +62,7 @@ void MovieClipNode::convertToOperations(NodeConverter &converter,
     }
   }
 
-  // always connect the output image
+  /* Always connect the output image. */
   MovieClipOperation *operation = new MovieClipOperation();
   operation->setMovieClip(movieClip);
   operation->setMovieClipUser(movieClipUser);
diff --git a/source/blender/compositor/operations/COM_DilateErodeOperation.cc b/source/blender/compositor/operations/COM_DilateErodeOperation.cc
index 2454f507664..e9305e0e192 100644
--- a/source/blender/compositor/operations/COM_DilateErodeOperation.cc
+++ b/source/blender/compositor/operations/COM_DilateErodeOperation.cc
@@ -24,7 +24,7 @@
 
 namespace blender::compositor {
 
-// DilateErode Distance Threshold
+/* DilateErode Distance Threshold */
 DilateErodeThresholdOperation::DilateErodeThresholdOperation()
 {
   this->addInputSocket(DataType::Value);
@@ -258,7 +258,7 @@ void DilateDistanceOperation::executeOpenCL(OpenCLDevice *device,
   device->COM_clEnqueueRange(dilateKernel, outputMemoryBuffer, 7, this);
 }
 
-// Erode Distance
+/* Erode Distance */
 ErodeDistanceOperation::ErodeDistanceOperation() : DilateDistanceOperation()
 {
   /* pass */
@@ -318,7 +318,7 @@ void ErodeDistanceOperation::executeOpenCL(OpenCLDevice *device,
   device->COM_clEnqueueRange(erodeKernel, outputMemoryBuffer, 7, this);
 }
 
-// Dilate step
+/* Dilate step */
 DilateStepOperation::DilateStepOperation()
 {
   this->addInputSocket(DataType::Value);
@@ -331,7 +331,7 @@ void DilateStepOperation::initExecution()
   this->m_inputProgram = this->getInputSocketReader(0);
 }
 
-// small helper to pass data from initializeTileData to executePixel
+/* Small helper to pass data from initializeTileData to executePixel. */
 struct tile_info {
   rcti rect;
   int width;
@@ -370,21 +370,21 @@ void *DilateStepOperation::initializeTileData(rcti *rect)
   int bwidth = rect->xmax - rect->xmin;
   int bheight = rect->ymax - rect->ymin;
 
-  // NOTE: Cache buffer has original tilesize width, but new height.
-  // We have to calculate the additional rows in the first pass,
-  // to have valid data available for the second pass.
+  /* NOTE: Cache buffer has original tilesize width, but new height.
+   * We have to calculate the additional rows in the first pass,
+   * to have valid data available for the second pass. */
   tile_info *result = create_cache(rect->xmin, rect->xmax, ymin, ymax);
   float *rectf = result->buffer;
 
-  // temp holds maxima for every step in the algorithm, buf holds a
-  // single row or column of input values, padded with FLT_MAX's to
-  // simplify the logic.
+  /* temp holds maxima for every step in the algorithm, buf holds a
+   * single row or column of input values, padded with FLT_MAX's to
+   * simplify the logic. */
   float *temp = (float *)MEM_mallocN(sizeof(float) * (2 * window - 1), "dilate erode temp");
   float *buf = (float *)MEM_mallocN(sizeof(float) * (MAX2(bwidth, bheight) + 5 * half_window),
                                     "dilate erode buf");
 
-  // The following is based on the van Herk/Gil-Werman algorithm for morphology operations.
-  // first pass, horizontal dilate/erode
+  /* The following is based on the van Herk/Gil-Werman algorithm for morphology operations.
+   * first pass, horizontal dilate/erode. */
   for (y = ymin; y < ymax; y++) {
     for (x = 0; x < bwidth + 5 * half_window; x++) {
       buf[x] = -FLT_MAX;
@@ -409,7 +409,7 @@ void *DilateStepOperation::initializeTileData(rcti *rect)
     }
   }
 
-  // second pass, vertical dilate/erode
+  /* Second pass, vertical dilate/erode. */
   for (x = 0; x < bwidth; x++) {
     for (y = 0; y < bheight + 5 * half_window; y++) {
       buf[y] = -FLT_MAX;
@@ -475,7 +475,7 @@ bool DilateStepOperation::determineDependingAreaOfInterest(rcti *input,
   return NodeOperation::determineDependingAreaOfInterest(&newInput, readOperation, output);
 }
 
-// Erode step
+/* Erode step */
 ErodeStepOperation::ErodeStepOperation() : DilateStepOperation()
 {
   /* pass */
@@ -500,21 +500,21 @@ void *ErodeStepOperation::initializeTileData(rcti *rect)
   int bwidth = rect->xmax - rect->xmin;
   int bheight = rect->ymax - rect->ymin;
 
-  // NOTE: Cache buffer has original tilesize width, but new height.
-  // We have to calculate the additional rows in the first pass,
-  // to have valid data available for the second pass.
+  /* NOTE: Cache buffer has original tilesize width, but new height.
+   * We have to calculate the additional rows in the first pass,
+   * to have valid data available for the second pass. */
   tile_info *result = create_cache(rect->xmin, rect->xmax, ymin, ymax);
   float *rectf = result->buffer;
 
-  // temp holds maxima for every step in the algorithm, buf holds a
-  // single row or column of input values, padded with FLT_MAX's to
-  // simplify the logic.
+  /* temp holds maxima for every step in the algorithm, buf holds a
+   * single row or column of input values, padded with FLT_MAX's to
+   * simplify the logic. */
   float *temp = (float *)MEM_mallocN(sizeof(float) * (2 * window - 1), "dilate erode temp");
   float *buf = (float *)MEM_mallocN(sizeof(float) * (MAX2(bwidth, bheight) + 5 * half_window),
                                     "dilate erode buf");
 
-  // The following is based on the van Herk/Gil-Werman algorithm for morphology operations.
-  // first pass, horizontal dilate/erode
+  /* The following is based on the van Herk/Gil-Werman algorithm for morphology operations.
+   * first pass, horizontal dilate/erode */
   for (y = ymin; y < ymax; y++) {
     for (x = 0; x < bwidth + 5 * half_window; x++) {
       buf[x] = FLT_MAX;
@@ -539,7 +539,7 @@ void *ErodeStepOperation::initializeTileData(rcti *rect)
     }
   }
 
-  // second pass, vertical dilate/erode
+  /* Second pass, vertical dilate/erode. */
   for (x = 0; x < bwidth; x++) {
     for (y = 0; y < bheight + 5 * half_window; y++) {
       buf[y] = FLT_MAX;
diff --git a/source/blender/compositor/operations/COM_OutputFileOperation.cc b/source/blender/compositor/operations/COM_OutputFileOperation.cc
index 7e896046f01..6c5984e3414 100644
--- a/source/blender/compositor/operations/COM_OutputFileOperation.cc
+++ b/source/blender/compositor/operations/COM_OutputFileOperation.cc
@@ -160,7 +160,7 @@ int get_datatype_size(DataType datatype)
 
 static float *init_buffer(unsigned int width, unsigned int height, DataType datatype)
 {
-  // When initializing the tree during initial load the width and height can be zero.
+  /* When initializing the tree during initial load the width and height can be zero. */
   if (width != 0 && height != 0) {
     int size = get_datatype_size(datatype);
     return (float *)MEM_callocN(width * height * size * sizeof(float), "OutputFile buffer");
diff --git a/source/blender/compositor/operations/COM_WrapOperation.cc b/source/blender/compositor/operations/COM_WrapOperation.cc
index d0d2fcac3ac..888602114cc 100644
--- a/source/blender/compositor/operations/COM_WrapOperation.cc
+++ b/source/blender/compositor/operations/COM_WrapOperation.cc
@@ -57,20 +57,20 @@ void WrapOperation::executePixelSampled(float output[4], float x, float y, Pixel
   MemoryBufferExtend extend_x = MemoryBufferExtend::Clip, extend_y = MemoryBufferExtend::Clip;
   switch (m_wrappingType) {
     case CMP_NODE_WRAP_NONE:
-      // Intentionally empty, originalXPos and originalYPos have been set before
+      /* Intentionally empty, originalXPos and originalYPos have been set before. */
       break;
     case CMP_NODE_WRAP_X:
-      // wrap only on the x-axis
+      /* Wrap only on the x-axis. */
       nx = this->getWrappedOriginalXPos(x);
       extend_x = MemoryBufferExtend::Repeat;
       break;
     case CMP_NODE_WRAP_Y:
-      // wrap only on the y-axis
+      /* Wrap only on the y-axis. */
       ny = this->getWrappedOriginalYPos(y);
       extend_y = MemoryBufferExtend::Repeat;
       break;
     case CMP_NODE_WRAP_XY:
-      // wrap on both
+      /* Wrap on both. */
       nx = this->getWrappedOriginalXPos(x);
       ny = this->getWrappedOriginalYPos(y);
       extend_x = MemoryBufferExtend::Repeat;
@@ -92,7 +92,7 @@ bool WrapOperation::determineDependingAreaOfInterest(rcti *input,
   newInput.ymax = input->ymax;
 
   if (ELEM(m_wrappingType, CMP_NODE_WRAP_X, CMP_NODE_WRAP_XY)) {
-    // wrap only on the x-axis if tile is wrapping
+    /* Wrap only on the x-axis if tile is wrapping. */
     newInput.xmin = getWrappedOriginalXPos(input->xmin);
     newInput.xmax = roundf(getWrappedOriginalXPos(input->xmax));
     if (newInput.xmin >= newInput.xmax) {
@@ -101,7 +101,7 @@ bool WrapOperation::determineDependingAreaOfInterest(rcti *input,
     }
   }
   if (ELEM(m_wrappingType, CMP_NODE_WRAP_Y, CMP_NODE_WRAP_XY)) {
-    // wrap only on the y-axis if tile is wrapping
+    /* Wrap only on the y-axis if tile is wrapping. */
     newInput.ymin = getWrappedOriginalYPos(input->ymin);
     newInput.ymax = roundf(getWrappedOriginalYPos(input->ymax));
     if (newInput.ymin >= newInput.ymax) {
diff --git a/source/blender/depsgraph/DEG_depsgraph.h b/source/blender/depsgraph/DEG_depsgraph.h
index 749b1bba871..47dad17b482 100644
--- a/source/blender/depsgraph/DEG_depsgraph.h
+++ b/source/blender/depsgraph/DEG_depsgraph.h
@@ -85,7 +85,7 @@ extern "C" {
 // Get main depsgraph instance from context!
 
 /* Create new Depsgraph instance */
-// TODO: what args are needed here? What's the building-graph entry point?
+/* TODO: what args are needed here? What's the building-graph entry point? */
 Depsgraph *DEG_graph_new(struct Main *bmain,
                          struct Scene *scene,
                          struct ViewLayer *view_layer,
diff --git a/source/blender/gpu/shaders/gpu_shader_3D_point_uniform_size_aa_vert.glsl b/source/blender/gpu/shaders/gpu_shader_3D_point_uniform_size_aa_vert.glsl
index f5b6d2ea3ed..5d67658c639 100644
--- a/source/blender/gpu/shaders/gpu_shader_3D_point_uniform_size_aa_vert.glsl
+++ b/source/blender/gpu/shaders/gpu_shader_3D_point_uniform_size_aa_vert.glsl
@@ -14,14 +14,14 @@ void main()
   gl_Position = ModelViewProjectionMatrix * pos_4d;
   gl_PointSize = size;
 
-  // calculate concentric radii in pixels
+  /* Calculate concentric radii in pixels. */
   float radius = 0.5 * size;
 
-  // start at the outside and progress toward the center
+  /* Start at the outside and progress toward the center. */
   radii[0] = radius;
   radii[1] = radius - 1.0;
 
-  // convert to PointCoord units
+  /* Convert to PointCoord units. */
   radii /= size;
 
 #ifdef USE_WORLD_CLIP_PLANES
diff --git a/source/blender/imbuf/intern/dds/ColorBlock.h b/source/blender/imbuf/intern/dds/ColorBlock.h
index 158695cfbf3..934837bb129 100644
--- a/source/blender/imbuf/intern/dds/ColorBlock.h
+++ b/source/blender/imbuf/intern/dds/ColorBlock.h
@@ -25,7 +25,7 @@
  * Original license from NVIDIA follows.
  */
 
-// This code is in the public domain -- <castanyo@yahoo.es>
+/* This code is in the public domain -- <castanyo@yahoo.es> */
 
 #pragma once
 
diff --git a/source/blender/imbuf/intern/openexr/openexr_api.cpp b/source/blender/imbuf/intern/openexr/openexr_api.cpp
index d1fa26e1a3e..a465c6b92bc 100644
--- a/source/blender/imbuf/intern/openexr/openexr_api.cpp
+++ b/source/blender/imbuf/intern/openexr/openexr_api.cpp
@@ -69,7 +69,7 @@
 
 extern "C" {
 
-// The following prevents a linking error in debug mode for MSVC using the libs in CVS
+/* The following prevents a linking error in debug mode for MSVC using the libs in SVN. */
 #if defined(WITH_OPENEXR) && defined(_WIN32) && defined(DEBUG) && _MSC_VER < 1900
 _CRTIMP void __cdecl _invalid_parameter_noinfo(void)
 {
diff --git a/source/blender/windowmanager/intern/wm_window.c b/source/blender/windowmanager/intern/wm_window.c
index 8f37e7f34a9..93417213a65 100644
--- a/source/blender/windowmanager/intern/wm_window.c
+++ b/source/blender/windowmanager/intern/wm_window.c
@@ -1058,7 +1058,7 @@ void wm_window_make_drawable(wmWindowManager *wm, wmWindow *win)
   BLI_assert(GPU_framebuffer_active_get() == GPU_framebuffer_back_get());
 
   if (win != wm->windrawable && win->ghostwin) {
-    //      win->lmbut = 0; /* keeps hanging when mousepressed while other window opened */
+    // win->lmbut = 0; /* Keeps hanging when mouse-pressed while other window opened. */
     wm_window_clear_drawable(wm);
 
     if (G.debug & G_DEBUG_EVENTS) {