Cleanup: use C style doxygen comments

14 files changed, 77 insertions, 77 deletions

diff --git a/source/blender/blenkernel/BKE_node.h b/source/blender/blenkernel/BKE_node.h
index 5e8b371e604..3421aa9e900 100644
--- a/source/blender/blenkernel/BKE_node.h
+++ b/source/blender/blenkernel/BKE_node.h
@@ -254,23 +254,23 @@ typedef struct bNodeType {
    * \note Used as a fallback when #bNode.label isn't set.
    */
   void (*labelfunc)(struct bNodeTree *ntree, struct bNode *node, char *label, int maxlen);
-  /// Optional custom resize handle polling.
+  /** Optional custom resize handle polling. */
   int (*resize_area_func)(struct bNode *node, int x, int y);
-  /// Optional selection area polling.
+  /** Optional selection area polling. */
   int (*select_area_func)(struct bNode *node, int x, int y);
-  /// Optional tweak area polling (for grabbing).
+  /** Optional tweak area polling (for grabbing). */
   int (*tweak_area_func)(struct bNode *node, int x, int y);
 
-  /// Called when the node is updated in the editor.
+  /** Called when the node is updated in the editor. */
   void (*updatefunc)(struct bNodeTree *ntree, struct bNode *node);
-  /// Check and update if internal ID data has changed.
+  /** Check and update if internal ID data has changed. */
   void (*group_update_func)(struct bNodeTree *ntree, struct bNode *node);
 
-  /// Initialize a new node instance of this type after creation.
+  /** Initialize a new node instance of this type after creation. */
   void (*initfunc)(struct bNodeTree *ntree, struct bNode *node);
-  /// Free the node instance.
+  /** Free the node instance. */
   void (*freefunc)(struct bNode *node);
-  /// Make a copy of the node instance.
+  /** Make a copy of the node instance. */
   void (*copyfunc)(struct bNodeTree *dest_ntree,
                    struct bNode *dest_node,
                    const struct bNode *src_node);
diff --git a/source/blender/compositor/intern/COM_ExecutionGroup.cpp b/source/blender/compositor/intern/COM_ExecutionGroup.cpp
index e5dfee7d0cd..08f794d7eba 100644
--- a/source/blender/compositor/intern/COM_ExecutionGroup.cpp
+++ b/source/blender/compositor/intern/COM_ExecutionGroup.cpp
@@ -198,13 +198,13 @@ void ExecutionGroup::execute(ExecutionSystem *graph)
   const bNodeTree *bTree = context.getbNodeTree();
   if (this->m_width == 0 || this->m_height == 0) {
     return;
-  }  /// \note Break out... no pixels to calculate.
+  } /** \note Break out... no pixels to calculate. */
   if (bTree->test_break && bTree->test_break(bTree->tbh)) {
     return;
-  }  /// \note Early break out for blur and preview nodes.
+  } /** \note Early break out for blur and preview nodes. */
   if (this->m_numberOfChunks == 0) {
     return;
-  }  /// \note Early break out.
+  } /** \note Early break out. */
   unsigned int chunkNumber;
 
   this->m_executionStartTime = PIL_check_seconds_timer();
diff --git a/source/blender/compositor/intern/COM_NodeGraph.cpp b/source/blender/compositor/intern/COM_NodeGraph.cpp
index 01dd662ad11..fe680f61a90 100644
--- a/source/blender/compositor/intern/COM_NodeGraph.cpp
+++ b/source/blender/compositor/intern/COM_NodeGraph.cpp
@@ -184,7 +184,7 @@ NodeOutput *NodeGraph::find_output(const NodeRange &node_range, bNodeSocket *b_s
 
 void NodeGraph::add_bNodeLink(const NodeRange &node_range, bNodeLink *b_nodelink)
 {
-  /// \note Ignore invalid links.
+  /** \note Ignore invalid links. */
   if (!(b_nodelink->flag & NODE_LINK_VALID)) {
     return;
   }
diff --git a/source/blender/compositor/intern/COM_WorkScheduler.cpp b/source/blender/compositor/intern/COM_WorkScheduler.cpp
index 06929f0037e..570e1eeba20 100644
--- a/source/blender/compositor/intern/COM_WorkScheduler.cpp
+++ b/source/blender/compositor/intern/COM_WorkScheduler.cpp
@@ -44,26 +44,26 @@
 #  error COM_CURRENT_THREADING_MODEL No threading model selected
 #endif
 
-/// \brief list of all CPUDevices. for every hardware thread an instance of CPUDevice is created
+/** \brief list of all CPUDevices. for every hardware thread an instance of CPUDevice is created */
 static vector<CPUDevice *> g_cpudevices;
 static ThreadLocal(CPUDevice *) g_thread_device;
 
 #if COM_CURRENT_THREADING_MODEL == COM_TM_QUEUE
-/// \brief list of all thread for every CPUDevice in cpudevices a thread exists
+/** \brief list of all thread for every CPUDevice in cpudevices a thread exists. */
 static ListBase g_cputhreads;
 static bool g_cpuInitialized = false;
-/// \brief all scheduled work for the cpu
+/** \brief all scheduled work for the cpu */
 static ThreadQueue *g_cpuqueue;
 static ThreadQueue *g_gpuqueue;
 #  ifdef COM_OPENCL_ENABLED
 static cl_context g_context;
 static cl_program g_program;
-/// \brief list of all OpenCLDevices. for every OpenCL GPU device an instance of OpenCLDevice is
-/// created
+/** \brief list of all OpenCLDevices. for every OpenCL GPU device an instance of OpenCLDevice is
+ * created. */
 static vector<OpenCLDevice *> g_gpudevices;
-/// \brief list of all thread for every GPUDevice in cpudevices a thread exists
+/** \brief list of all thread for every GPUDevice in cpudevices a thread exists. */
 static ListBase g_gputhreads;
-/// \brief all scheduled work for the gpu
+/** \brief all scheduled work for the GPU. */
 static bool g_openclActive = false;
 static bool g_openclInitialized = false;
 #  endif
diff --git a/source/blender/compositor/nodes/COM_ImageNode.cpp b/source/blender/compositor/nodes/COM_ImageNode.cpp
index 3dbd3773247..c178722a23f 100644
--- a/source/blender/compositor/nodes/COM_ImageNode.cpp
+++ b/source/blender/compositor/nodes/COM_ImageNode.cpp
@@ -72,7 +72,7 @@ NodeOperation *ImageNode::doMultilayerCheck(NodeConverter &converter,
 void ImageNode::convertToOperations(NodeConverter &converter,
                                     const CompositorContext &context) const
 {
-  /// Image output
+  /** Image output */
   NodeOutput *outputImage = this->getOutputSocket(0);
   bNode *editorNode = this->getbNode();
   Image *image = (Image *)editorNode->id;
diff --git a/source/blender/compositor/operations/COM_ReadBufferOperation.cpp b/source/blender/compositor/operations/COM_ReadBufferOperation.cpp
index 70aaab560cd..99cc9f5dd01 100644
--- a/source/blender/compositor/operations/COM_ReadBufferOperation.cpp
+++ b/source/blender/compositor/operations/COM_ReadBufferOperation.cpp
@@ -41,7 +41,7 @@ void ReadBufferOperation::determineResolution(unsigned int resolution[2],
     operation->determineResolution(resolution, preferredResolution);
     operation->setResolution(resolution);
 
-    /// \todo: may not occur!, but does with blur node
+    /** \todo: may not occur!, but does with blur node */
     if (this->m_memoryProxy->getExecutor()) {
       this->m_memoryProxy->getExecutor()->setResolution(resolution);
     }
diff --git a/source/blender/ikplugin/intern/iksolver_plugin.c b/source/blender/ikplugin/intern/iksolver_plugin.c
index ba096653e0f..c7d8a8b3723 100644
--- a/source/blender/ikplugin/intern/iksolver_plugin.c
+++ b/source/blender/ikplugin/intern/iksolver_plugin.c
@@ -583,8 +583,8 @@ static void free_posetree(PoseTree *tree)
   MEM_freeN(tree);
 }
 
-///----------------------------------------
-/// Plugin API for legacy iksolver
+/* ------------------------------
+ * Plugin API for legacy iksolver */
 
 void iksolver_initialize_tree(struct Depsgraph *UNUSED(depsgraph),
                               struct Scene *UNUSED(scene),
diff --git a/source/blender/imbuf/intern/dds/BlockDXT.cpp b/source/blender/imbuf/intern/dds/BlockDXT.cpp
index 1fbe7b46963..8978b823e2a 100644
--- a/source/blender/imbuf/intern/dds/BlockDXT.cpp
+++ b/source/blender/imbuf/intern/dds/BlockDXT.cpp
@@ -247,14 +247,14 @@ void BlockDXT1::setIndices(const int *idx)
   }
 }
 
-/// Flip DXT1 block vertically.
+/** Flip DXT1 block vertically. */
 inline void BlockDXT1::flip4()
 {
   swap(row[0], row[3]);
   swap(row[1], row[2]);
 }
 
-/// Flip half DXT1 block vertically.
+/** Flip half DXT1 block vertically. */
 inline void BlockDXT1::flip2()
 {
   swap(row[0], row[1]);
@@ -299,27 +299,27 @@ void AlphaBlockDXT3::decodeBlock(ColorBlock *block) const
   block->color(0xF).a = (alphaF << 4) | alphaF;
 }
 
-/// Flip DXT3 alpha block vertically.
+/** Flip DXT3 alpha block vertically. */
 void AlphaBlockDXT3::flip4()
 {
   swap(row[0], row[3]);
   swap(row[1], row[2]);
 }
 
-/// Flip half DXT3 alpha block vertically.
+/** Flip half DXT3 alpha block vertically. */
 void AlphaBlockDXT3::flip2()
 {
   swap(row[0], row[1]);
 }
 
-/// Flip DXT3 block vertically.
+/** Flip DXT3 block vertically. */
 void BlockDXT3::flip4()
 {
   alpha.flip4();
   color.flip4();
 }
 
-/// Flip half DXT3 block vertically.
+/** Flip half DXT3 block vertically. */
 void BlockDXT3::flip2()
 {
   alpha.flip2();
@@ -458,21 +458,21 @@ void BlockDXT5::decodeBlockNV5x(ColorBlock *block) const
   alpha.decodeBlock(block);
 }
 
-/// Flip DXT5 block vertically.
+/** Flip DXT5 block vertically. */
 void BlockDXT5::flip4()
 {
   alpha.flip4();
   color.flip4();
 }
 
-/// Flip half DXT5 block vertically.
+/** Flip half DXT5 block vertically. */
 void BlockDXT5::flip2()
 {
   alpha.flip2();
   color.flip2();
 }
 
-/// Decode ATI1 block.
+/** Decode ATI1 block. */
 void BlockATI1::decodeBlock(ColorBlock *block) const
 {
   uint8 alpha_array[8];
@@ -488,19 +488,19 @@ void BlockATI1::decodeBlock(ColorBlock *block) const
   }
 }
 
-/// Flip ATI1 block vertically.
+/** Flip ATI1 block vertically. */
 void BlockATI1::flip4()
 {
   alpha.flip4();
 }
 
-/// Flip half ATI1 block vertically.
+/** Flip half ATI1 block vertically. */
 void BlockATI1::flip2()
 {
   alpha.flip2();
 }
 
-/// Decode ATI2 block.
+/** Decode ATI2 block. */
 void BlockATI2::decodeBlock(ColorBlock *block) const
 {
   uint8 alpha_array[8];
@@ -525,14 +525,14 @@ void BlockATI2::decodeBlock(ColorBlock *block) const
   }
 }
 
-/// Flip ATI2 block vertically.
+/** Flip ATI2 block vertically. */
 void BlockATI2::flip4()
 {
   x.flip4();
   y.flip4();
 }
 
-/// Flip half ATI2 block vertically.
+/** Flip half ATI2 block vertically. */
 void BlockATI2::flip2()
 {
   x.flip2();
@@ -586,14 +586,14 @@ void BlockCTX1::setIndices(const int *idx)
   }
 }
 
-/// Flip CTX1 block vertically.
+/** Flip CTX1 block vertically. */
 inline void BlockCTX1::flip4()
 {
   swap(row[0], row[3]);
   swap(row[1], row[2]);
 }
 
-/// Flip half CTX1 block vertically.
+/** Flip half CTX1 block vertically. */
 inline void BlockCTX1::flip2()
 {
   swap(row[0], row[1]);
diff --git a/source/blender/imbuf/intern/dds/BlockDXT.h b/source/blender/imbuf/intern/dds/BlockDXT.h
index 70ec8808c61..83cc147c76c 100644
--- a/source/blender/imbuf/intern/dds/BlockDXT.h
+++ b/source/blender/imbuf/intern/dds/BlockDXT.h
@@ -55,7 +55,7 @@
 #include <Common.h>
 #include <Stream.h>
 
-/// DXT1 block.
+/** DXT1 block. */
 struct BlockDXT1 {
   Color16 col0;
   Color16 col1;
@@ -81,13 +81,13 @@ struct BlockDXT1 {
   void flip2();
 };
 
-/// Return true if the block uses four color mode, false otherwise.
+/** Return true if the block uses four color mode, false otherwise. */
 inline bool BlockDXT1::isFourColorMode() const
 {
   return col0.u > col1.u;
 }
 
-/// DXT3 alpha block with explicit alpha.
+/** DXT3 alpha block with explicit alpha. */
 struct AlphaBlockDXT3 {
   union {
     struct {
@@ -117,7 +117,7 @@ struct AlphaBlockDXT3 {
   void flip2();
 };
 
-/// DXT3 block.
+/** DXT3 block. */
 struct BlockDXT3 {
   AlphaBlockDXT3 alpha;
   BlockDXT1 color;
@@ -129,7 +129,7 @@ struct BlockDXT3 {
   void flip2();
 };
 
-/// DXT5 alpha block.
+/** DXT5 alpha block. */
 struct AlphaBlockDXT5 {
   // uint64 unions do not compile on all platforms
 #if 0
@@ -245,7 +245,7 @@ struct AlphaBlockDXT5 {
   void flip2();
 };
 
-/// DXT5 block.
+/** DXT5 block. */
 struct BlockDXT5 {
   AlphaBlockDXT5 alpha;
   BlockDXT1 color;
@@ -257,7 +257,7 @@ struct BlockDXT5 {
   void flip2();
 };
 
-/// ATI1 block.
+/** ATI1 block. */
 struct BlockATI1 {
   AlphaBlockDXT5 alpha;
 
@@ -267,7 +267,7 @@ struct BlockATI1 {
   void flip2();
 };
 
-/// ATI2 block.
+/** ATI2 block. */
 struct BlockATI2 {
   AlphaBlockDXT5 x;
   AlphaBlockDXT5 y;
@@ -278,7 +278,7 @@ struct BlockATI2 {
   void flip2();
 };
 
-/// CTX1 block.
+/** CTX1 block. */
 struct BlockCTX1 {
   uint8 col0[2];
   uint8 col1[2];
diff --git a/source/blender/imbuf/intern/dds/Color.h b/source/blender/imbuf/intern/dds/Color.h
index d0b67d4638c..4a9202617f5 100644
--- a/source/blender/imbuf/intern/dds/Color.h
+++ b/source/blender/imbuf/intern/dds/Color.h
@@ -29,7 +29,7 @@
 
 #pragma once
 
-/// 32 bit color stored as BGRA.
+/** 32 bit color stored as BGRA. */
 class Color32 {
  public:
   Color32()
@@ -93,7 +93,7 @@ class Color32 {
   };
 };
 
-/// 16 bit 565 BGR color.
+/** 16 bit 565 BGR color. */
 class Color16 {
  public:
   Color16()
diff --git a/source/blender/imbuf/intern/dds/ColorBlock.cpp b/source/blender/imbuf/intern/dds/ColorBlock.cpp
index 69757d797b5..f2e8e0b0313 100644
--- a/source/blender/imbuf/intern/dds/ColorBlock.cpp
+++ b/source/blender/imbuf/intern/dds/ColorBlock.cpp
@@ -46,12 +46,12 @@ inline static uint colorDistance(Color32 c0, Color32 c1)
 }
 #endif
 
-/// Default constructor.
+/** Default constructor. */
 ColorBlock::ColorBlock()
 {
 }
 
-/// Init the color block from an array of colors.
+/** Init the color block from an array of colors. */
 ColorBlock::ColorBlock(const uint *linearImage)
 {
   for (uint i = 0; i < 16; i++) {
@@ -59,7 +59,7 @@ ColorBlock::ColorBlock(const uint *linearImage)
   }
 }
 
-/// Init the color block with the contents of the given block.
+/** Init the color block with the contents of the given block. */
 ColorBlock::ColorBlock(const ColorBlock &block)
 {
   for (uint i = 0; i < 16; i++) {
@@ -67,7 +67,7 @@ ColorBlock::ColorBlock(const ColorBlock &block)
   }
 }
 
-/// Initialize this color block.
+/** Initialize this color block. */
 ColorBlock::ColorBlock(const Image *img, uint x, uint y)
 {
   init(img, x, y);
@@ -159,7 +159,7 @@ void ColorBlock::swizzle(uint x, uint y, uint z, uint w)
   }
 }
 
-/// Returns true if the block has a single color.
+/** Returns true if the block has a single color. */
 bool ColorBlock::isSingleColor(Color32 mask /*= Color32(0xFF, 0xFF, 0xFF, 0x00)*/) const
 {
   uint u = m_color[0].u & mask.u;
@@ -174,7 +174,7 @@ bool ColorBlock::isSingleColor(Color32 mask /*= Color32(0xFF, 0xFF, 0xFF, 0x00)*
 }
 
 #if 0
-/// Returns true if the block has a single color, ignoring transparent pixels.
+/** Returns true if the block has a single color, ignoring transparent pixels. */
 bool ColorBlock::isSingleColorNoAlpha() const
 {
   Color32 c;
@@ -199,7 +199,7 @@ bool ColorBlock::isSingleColorNoAlpha() const
 #endif
 
 #if 0
-/// Count number of unique colors in this color block.
+/** Count number of unique colors in this color block. */
 uint ColorBlock::countUniqueColors() const
 {
   uint count = 0;
@@ -223,7 +223,7 @@ uint ColorBlock::countUniqueColors() const
 #endif
 
 #if 0
-/// Get average color of the block.
+/** Get average color of the block. */
 Color32 ColorBlock::averageColor() const
 {
   uint r, g, b, a;
@@ -240,7 +240,7 @@ Color32 ColorBlock::averageColor() const
 }
 #endif
 
-/// Return true if the block is not fully opaque.
+/** Return true if the block is not fully opaque. */
 bool ColorBlock::hasAlpha() const
 {
   for (uint i = 0; i < 16; i++) {
@@ -253,7 +253,7 @@ bool ColorBlock::hasAlpha() const
 
 #if 0
 
-/// Get diameter color range.
+/** Get diameter color range. */
 void ColorBlock::diameterRange(Color32 *start, Color32 *end) const
 {
   Color32 c0, c1;
@@ -274,7 +274,7 @@ void ColorBlock::diameterRange(Color32 *start, Color32 *end) const
   *end = c1;
 }
 
-/// Get luminance color range.
+/** Get luminance color range. */
 void ColorBlock::luminanceRange(Color32 *start, Color32 *end) const
 {
   Color32 minColor, maxColor;
@@ -299,7 +299,7 @@ void ColorBlock::luminanceRange(Color32 *start, Color32 *end) const
   *end = maxColor;
 }
 
-/// Get color range based on the bounding box.
+/** Get color range based on the bounding box. */
 void ColorBlock::boundsRange(Color32 *start, Color32 *end) const
 {
   Color32 minColor(255, 255, 255);
@@ -344,7 +344,7 @@ void ColorBlock::boundsRange(Color32 *start, Color32 *end) const
   *end = maxColor;
 }
 
-/// Get color range based on the bounding box.
+/** Get color range based on the bounding box. */
 void ColorBlock::boundsRangeAlpha(Color32 *start, Color32 *end) const
 {
   Color32 minColor(255, 255, 255, 255);
@@ -400,7 +400,7 @@ void ColorBlock::boundsRangeAlpha(Color32 *start, Color32 *end) const
 #endif
 
 #if 0
-/// Sort colors by abosolute value in their 16 bit representation.
+/** Sort colors by abosolute value in their 16 bit representation. */
 void ColorBlock::sortColorsByAbsoluteValue()
 {
   // Dummy selection sort.
@@ -422,7 +422,7 @@ void ColorBlock::sortColorsByAbsoluteValue()
 #endif
 
 #if 0
-/// Find extreme colors in the given axis.
+/** Find extreme colors in the given axis. */
 void ColorBlock::computeRange(Vector3::Arg axis, Color32 *start, Color32 *end) const
 {
 
@@ -452,7 +452,7 @@ void ColorBlock::computeRange(Vector3::Arg axis, Color32 *start, Color32 *end) c
 #endif
 
 #if 0
-/// Sort colors in the given axis.
+/** Sort colors in the given axis. */
 void ColorBlock::sortColors(const Vector3 &axis)
 {
   float luma_array[16];
@@ -477,7 +477,7 @@ void ColorBlock::sortColors(const Vector3 &axis)
 #endif
 
 #if 0
-/// Get the volume of the color block.
+/** Get the volume of the color block. */
 float ColorBlock::volume() const
 {
   Box bounds;
diff --git a/source/blender/imbuf/intern/dds/ColorBlock.h b/source/blender/imbuf/intern/dds/ColorBlock.h
index dd63286e230..98b4c9cb40a 100644
--- a/source/blender/imbuf/intern/dds/ColorBlock.h
+++ b/source/blender/imbuf/intern/dds/ColorBlock.h
@@ -32,7 +32,7 @@
 #include <Color.h>
 #include <Image.h>
 
-/// Uncompressed 4x4 color block.
+/** Uncompressed 4x4 color block. */
 struct ColorBlock {
   ColorBlock();
   ColorBlock(const uint *linearImage);
@@ -61,31 +61,31 @@ struct ColorBlock {
   Color32 m_color[4 * 4];
 };
 
-/// Get pointer to block colors.
+/** Get pointer to block colors. */
 inline const Color32 *ColorBlock::colors() const
 {
   return m_color;
 }
 
-/// Get block color.
+/** Get block color. */
 inline Color32 ColorBlock::color(uint i) const
 {
   return m_color[i];
 }
 
-/// Get block color.
+/** Get block color. */
 inline Color32 &ColorBlock::color(uint i)
 {
   return m_color[i];
 }
 
-/// Get block color.
+/** Get block color. */
 inline Color32 ColorBlock::color(uint x, uint y) const
 {
   return m_color[y * 4 + x];
 }
 
-/// Get block color.
+/** Get block color. */
 inline Color32 &ColorBlock::color(uint x, uint y)
 {
   return m_color[y * 4 + x];
diff --git a/source/blender/imbuf/intern/dds/DirectDrawSurface.h b/source/blender/imbuf/intern/dds/DirectDrawSurface.h
index ac7f893fddd..373d5974a5e 100644
--- a/source/blender/imbuf/intern/dds/DirectDrawSurface.h
+++ b/source/blender/imbuf/intern/dds/DirectDrawSurface.h
@@ -73,7 +73,7 @@ struct DDSCaps {
   uint caps4;
 };
 
-/// DDS file header for DX10.
+/** DDS file header for DX10. */
 struct DDSHeader10 {
   uint dxgiFormat;
   uint resourceDimension;
@@ -82,7 +82,7 @@ struct DDSHeader10 {
   uint reserved;
 };
 
-/// DDS file header.
+/** DDS file header. */
 struct DDSHeader {
   uint fourcc;
   uint size;
@@ -132,7 +132,7 @@ struct DDSHeader {
   uint d3d9Format() const;
 };
 
-/// DirectDraw Surface. (DDS)
+/** DirectDraw Surface. (DDS) */
 class DirectDrawSurface {
  public:
   DirectDrawSurface(unsigned char *mem, uint size);
diff --git a/source/blender/imbuf/intern/dds/Image.h b/source/blender/imbuf/intern/dds/Image.h
index 4ccfec99445..0f977641d89 100644
--- a/source/blender/imbuf/intern/dds/Image.h
+++ b/source/blender/imbuf/intern/dds/Image.h
@@ -32,7 +32,7 @@
 #include "Color.h"
 #include "Common.h"
 
-/// 32 bit RGBA image.
+/** 32 bit RGBA image. */
 class Image {
  public:
   enum Format {