Revision: 77052
http://sourceforge.net/p/brlcad/code/77052
Author: brlcad
Date: 2020-09-04 04:09:09 +0000 (Fri, 04 Sep 2020)
Log Message:
-----------
document the struct elements where already documented
Modified Paths:
--------------
brlcad/trunk/include/bn/plane.h
Modified: brlcad/trunk/include/bn/plane.h
===================================================================
--- brlcad/trunk/include/bn/plane.h 2020-09-04 04:01:16 UTC (rev 77051)
+++ brlcad/trunk/include/bn/plane.h 2020-09-04 04:09:09 UTC (rev 77052)
@@ -43,51 +43,51 @@
__BEGIN_DECLS
-#define MAXPTS 4 /* All we need are 4 points */
-#define pl_A pl_points[0] /* Synonym for A point */
+#define MAXPTS 4 /**< All we need are 4 points */
+#define pl_A pl_points[0] /**< Synonym for A point */
struct plane_specific {
- size_t pl_npts; /* number of points on plane */
- point_t pl_points[MAXPTS]; /* Actual points on plane */
- vect_t pl_Xbasis; /* X (B-A) vector (for 2d coords) */
- vect_t pl_Ybasis; /* Y (C-A) vector (for 2d coords) */
- vect_t pl_N; /* Unit-length Normal (outward) */
- fastf_t pl_NdotA; /* Normal dot A */
- fastf_t pl_2d_x[MAXPTS]; /* X 2d-projection of points */
- fastf_t pl_2d_y[MAXPTS]; /* Y 2d-projection of points */
- fastf_t pl_2d_com[MAXPTS]; /* pre-computed common-term */
- struct plane_specific *pl_forw; /* Forward link */
- char pl_code[MAXPTS+1]; /* Face code string. Decorative. */
+ size_t pl_npts; /**< number of points on plane */
+ point_t pl_points[MAXPTS]; /**< Actual points on plane */
+ vect_t pl_Xbasis; /**< X (B-A) vector (for 2d coords) */
+ vect_t pl_Ybasis; /**< Y (C-A) vector (for 2d coords) */
+ vect_t pl_N; /**< Unit-length Normal (outward) */
+ fastf_t pl_NdotA; /**< Normal dot A */
+ fastf_t pl_2d_x[MAXPTS]; /**< X 2d-projection of points */
+ fastf_t pl_2d_y[MAXPTS]; /**< Y 2d-projection of points */
+ fastf_t pl_2d_com[MAXPTS]; /**< pre-computed common-term */
+ struct plane_specific *pl_forw; /**< Forward link */
+ char pl_code[MAXPTS+1]; /**< Face code string. Decorative. */
};
-/*
+/**
* Describe the tri_specific structure.
*/
struct tri_specific {
- point_t tri_A; /* triangle vertex (A) */
- vect_t tri_BA; /* B - A (second point) */
- vect_t tri_CA; /* C - A (third point) */
- vect_t tri_wn; /* facet normal (non-unit) */
- vect_t tri_N; /* unit normal vector */
- fastf_t *tri_normals; /* unit vertex normals A, B, C (this
is malloced storage) */
- int tri_surfno; /* solid specific surface number */
- struct tri_specific *tri_forw; /* Next facet */
+ point_t tri_A; /**< triangle vertex (A) */
+ vect_t tri_BA; /**< B - A (second point) */
+ vect_t tri_CA; /**< C - A (third point) */
+ vect_t tri_wn; /**< facet normal (non-unit) */
+ vect_t tri_N; /**< unit normal vector */
+ fastf_t *tri_normals; /**< unit vertex normals A, B, C (this
is malloced storage) */
+ int tri_surfno; /**< solid specific surface number */
+ struct tri_specific *tri_forw; /**< Next facet */
};
typedef struct tri_specific tri_specific_double;
-/*
+/**
* A more memory conservative version
*/
struct tri_float_specific {
- float tri_A[3]; /* triangle vertex (A) */
- float tri_BA[3]; /* B - A (second point) */
- float tri_CA[3]; /* C - A (third point) */
- float tri_wn[3]; /* facet normal (non-unit) */
- float tri_N[3]; /* unit normal vector */
- signed char *tri_normals; /* unit vertex normals A, B, C (this
is malloced storage) */
- int tri_surfno; /* solid specific surface number */
- struct tri_float_specific *tri_forw;/* Next facet */
+ float tri_A[3]; /**< triangle vertex (A) */
+ float tri_BA[3]; /**< B - A (second point) */
+ float tri_CA[3]; /**< C - A (third point) */
+ float tri_wn[3]; /**< facet normal (non-unit) */
+ float tri_N[3]; /**< unit normal vector */
+ signed char *tri_normals; /**< unit vertex normals A, B, C (this
is malloced storage) */
+ int tri_surfno; /**< solid specific surface number */
+ struct tri_float_specific *tri_forw;/**< Next facet */
};
typedef struct tri_float_specific tri_specific_float;
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
