From 8c1726918374e1d2d2123e17bae8db5aadde3433 Mon Sep 17 00:00:00 2001
From: Campbell Barton <ideasman42@gmail.com>
Date: Sat, 12 Sep 2020 16:33:34 +1000
Subject: Cleanup: use C style doxygen comments

---
 source/blender/imbuf/intern/dds/ColorBlock.cpp | 34 +++++++++++++-------------
 1 file changed, 17 insertions(+), 17 deletions(-)

(limited to 'source/blender/imbuf/intern/dds/ColorBlock.cpp')

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;
-- 
cgit v1.2.3