Revision: 77054
http://sourceforge.net/p/brlcad/code/77054
Author: brlcad
Date: 2020-09-04 04:14:46 +0000 (Fri, 04 Sep 2020)
Log Message:
-----------
doxygen / comment cleanup
Modified Paths:
--------------
brlcad/trunk/include/bn/anim.h
brlcad/trunk/include/bn/complex.h
brlcad/trunk/include/bn/noise.h
brlcad/trunk/include/bn/poly.h
brlcad/trunk/include/bn/rand.h
brlcad/trunk/include/bu/color.h
brlcad/trunk/include/bu/column.h
brlcad/trunk/include/bu/endian.h
brlcad/trunk/include/bu/tbl.h
Modified: brlcad/trunk/include/bn/anim.h
===================================================================
--- brlcad/trunk/include/bn/anim.h 2020-09-04 04:13:26 UTC (rev 77053)
+++ brlcad/trunk/include/bn/anim.h 2020-09-04 04:14:46 UTC (rev 77054)
@@ -127,13 +127,13 @@
(o)[7] = (i)[9];\
(o)[8] = (i)[10];}
-/* tilde matrix: [M]a = v X a */
+/** tilde matrix: [M]a = v X a */
#define MAKE_TILDE(m, v) {\
MAT3ZERO(m);\
m[1]= -v[2]; m[2]=v[1]; m[3]= v[2];\
m[5]= -v[0]; m[6]= -v[1]; m[7]= v[0];}
-/* a = Ix Iy Iz b = Ixy Ixz Iyz*/
+/** a = Ix Iy Iz b = Ixy Ixz Iyz*/
#define INERTIAL_MAT3(m, a, b) {\
(m)[0] = (a)[0]; (m)[1] = -(b)[0]; (m)[2] = -(b)[1];\
(m)[3] = -(b)[0]; (m)[4] = (a)[1]; (m)[5] = -(b)[2];\
Modified: brlcad/trunk/include/bn/complex.h
===================================================================
--- brlcad/trunk/include/bn/complex.h 2020-09-04 04:13:26 UTC (rev 77053)
+++ brlcad/trunk/include/bn/complex.h 2020-09-04 04:14:46 UTC (rev 77054)
@@ -34,7 +34,7 @@
__BEGIN_DECLS
-/* "complex number" data type: */
+/** "complex number" data type */
typedef struct bn_complex {
double re; /**< @brief real part */
double im; /**< @brief imaginary part */
Modified: brlcad/trunk/include/bn/noise.h
===================================================================
--- brlcad/trunk/include/bn/noise.h 2020-09-04 04:13:26 UTC (rev 77053)
+++ brlcad/trunk/include/bn/noise.h 2020-09-04 04:14:46 UTC (rev 77054)
@@ -18,9 +18,9 @@
* information.
*/
-/*----------------------------------------------------------------------*/
-/** @addtogroup noise
+/**
+ * @addtogroup noise
*
* @brief
* These noise functions provide mostly random noise at the integer
@@ -137,7 +137,6 @@
double octaves);
/**
- *
* From "Texturing and Modeling, A Procedural Approach" 2nd ed
*/
BN_EXPORT extern double bn_noise_mf(point_t point,
Modified: brlcad/trunk/include/bn/poly.h
===================================================================
--- brlcad/trunk/include/bn/poly.h 2020-09-04 04:13:26 UTC (rev 77053)
+++ brlcad/trunk/include/bn/poly.h 2020-09-04 04:14:46 UTC (rev 77054)
@@ -41,7 +41,7 @@
__BEGIN_DECLS
/* This could be larger, or even dynamic... */
-#define BN_MAX_POLY_DEGREE 6 /* Maximum Poly Order */
+#define BN_MAX_POLY_DEGREE 6 /**< Maximum Poly Order */
/**
* Polynomial data type
Modified: brlcad/trunk/include/bn/rand.h
===================================================================
--- brlcad/trunk/include/bn/rand.h 2020-09-04 04:13:26 UTC (rev 77053)
+++ brlcad/trunk/include/bn/rand.h 2020-09-04 04:14:46 UTC (rev 77054)
@@ -76,7 +76,7 @@
#define BN_RANDHALF(_i) (bn_rand_table[ _i = (_i+1) % BN_RAND_TABSIZE ]-0.5)
#define BN_RANDHALF_INIT(_p) _p = bn_rand_table
-#define BN_RANDHALFTABSIZE 16535 /* Powers of two give streaking */
+#define BN_RANDHALFTABSIZE 16535 /**< Powers of two give streaking */
BN_EXPORT extern int bn_randhalftabsize;
/**
Modified: brlcad/trunk/include/bu/color.h
===================================================================
--- brlcad/trunk/include/bu/color.h 2020-09-04 04:13:26 UTC (rev 77053)
+++ brlcad/trunk/include/bu/color.h 2020-09-04 04:14:46 UTC (rev 77054)
@@ -30,8 +30,6 @@
__BEGIN_DECLS
-/*----------------------------------------------------------------------*/
-
/** @addtogroup bu_color
* @brief
* Support for storing and manipulating color data.
@@ -74,7 +72,7 @@
-/* random color generating methods */
+/** random color generating methods */
typedef enum {
BU_COLOR_RANDOM = 0,
BU_COLOR_RANDOM_LIGHTENED
@@ -94,7 +92,7 @@
#if 0
-/*
+/**
* Refactoring points:
* color command (set specified color)
* src/libged/color.c
Modified: brlcad/trunk/include/bu/column.h
===================================================================
--- brlcad/trunk/include/bu/column.h 2020-09-04 04:13:26 UTC (rev 77053)
+++ brlcad/trunk/include/bu/column.h 2020-09-04 04:14:46 UTC (rev 77054)
@@ -53,7 +53,8 @@
#define BU_COLUMN_ALL -1
-/* Generate an output string based on the specified layout and contents in the
+/**
+ * Generate an output string based on the specified layout and contents in the
* bu_column_state s. Return the number of items printed, or -1 if there is
* an error.
*
@@ -74,7 +75,8 @@
* Row suffix: none
* Fill order: column first
*
- * */
+ *
+ */
BU_EXPORT extern int bu_column_print(struct bu_vls *o, struct bu_column_state
*s);
/**
Modified: brlcad/trunk/include/bu/endian.h
===================================================================
--- brlcad/trunk/include/bu/endian.h 2020-09-04 04:13:26 UTC (rev 77053)
+++ brlcad/trunk/include/bu/endian.h 2020-09-04 04:14:46 UTC (rev 77054)
@@ -36,9 +36,9 @@
typedef enum {
- BU_LITTLE_ENDIAN = 1234, /* LSB first: i386, VAX order */
- BU_BIG_ENDIAN = 4321, /* MSB first: 68000, IBM, network order */
- BU_PDP_ENDIAN = 3412 /* LSB first in word, MSW first in long */
+ BU_LITTLE_ENDIAN = 1234, /**< LSB first: i386, VAX order */
+ BU_BIG_ENDIAN = 4321, /**< MSB first: 68000, IBM, network order */
+ BU_PDP_ENDIAN = 3412 /**< LSB first in word, MSW first in long */
} bu_endian_t;
Modified: brlcad/trunk/include/bu/tbl.h
===================================================================
--- brlcad/trunk/include/bu/tbl.h 2020-09-04 04:13:26 UTC (rev 77053)
+++ brlcad/trunk/include/bu/tbl.h 2020-09-04 04:14:46 UTC (rev 77054)
@@ -38,7 +38,7 @@
/** @{ */
/** @file bu/tbl.h */
-/*
+/**
* this is pulled from num.c where the guts to the table printer
* currently resides, moved here for easy reference.
*
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
_______________________________________________
BRL-CAD Source Commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-commits
