[brlcad-commits] SF.net SVN: brlcad:[57722] brlcad/trunk/include/bu.h

[<tbr...@us...>]

Revision: 57722
          http://sourceforge.net/p/brlcad/code/57722
Author:   tbrowder2
Date:     2013-09-18 15:29:43 +0000 (Wed, 18 Sep 2013)
Log Message:
-----------
clarify bu_ptbl comments; neaten Doxygen var comments

Modified Paths:
--------------
    brlcad/trunk/include/bu.h

Modified: brlcad/trunk/include/bu.h
===================================================================
--- brlcad/trunk/include/bu.h	2013-09-18 15:08:48 UTC (rev 57721)
+++ brlcad/trunk/include/bu.h	2013-09-18 15:29:43 UTC (rev 57722)
@@ -1678,9 +1678,9 @@
  * dynamic array.
  *
  * The table is currently un-ordered, and is merely an array of
- * pointers.  The support routines BU_*PTBL* manipulate the array for
- * you.  Pointers to be operated on (inserted, deleted, searched for)
- * are passed as a "pointer to long".
+ * pointers.  The support routines BU_*PTBL* and bu_ptbl* manipulate the
+ * array for you.  Pointers to be operated on (inserted, deleted, searched
+ * for) are passed as a "pointer to long".
  *
  */
 
@@ -1690,15 +1690,15 @@
  */
 struct bu_ptbl {
     struct bu_list l; /**< linked list for caller's use */
-    off_t end; /**< index into buffer of first available location */
-    size_t blen; /**< # of (long *)'s worth of storage at *buffer */
-    long **buffer; /**< data storage area */
+    off_t end;        /**< index into buffer of first available location */
+    size_t blen;      /**< # of (long *)'s worth of storage at *buffer */
+    long **buffer;    /**< data storage area */
 };
 typedef struct bu_ptbl bu_ptbl_t;
 #define BU_PTBL_NULL ((struct bu_ptbl *)0)
 
 /**
- * assert the integrity of a non-head node bu_ptbl struct.
+ * assert the integrity of a bu_ptbl struct pointer.
  */
 #define BU_CK_PTBL(_p) BU_CKMAG(_p, BU_PTBL_MAGIC, "bu_ptbl")
 

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.