[brlcad-commits] CVS: brlcad/src/libbu badmagic.c, 14.10, 14.11 bu_fgets.c, 14.2, 14.3 fopen_uniq.c, 14.13, 14.14 htond.c, 14.12, 14.13 htonf.c, 14.12, 14.13 ispar.c, 14.13, 14.14 linebuf.c, 14.15, 14.16 list.c, 14.10, 14.11 log.c, 14.11, 14.12 magic.c, 14.11, 14.12 mappedfile.c, 14.15, 14.16 mread.c, 1.7, 1.8 mro.c, 14.11, 14.12 observer.c, 14.12, 14.13 parallel.c, 14.21, 14.22 parse.c, 14.12, 14.13 printb.c, 14.12, 14.13 ptbl.c, 14.11, 14.12 rb_internals.h, 14.11, 14.12 semaphore.c, 14.13, 14.14 vfont.c, 14.14, 14.15 vls.c, 14.19, 14.20

[Lee B. <lb...@us...>]

Update of /cvsroot/brlcad/brlcad/src/libbu
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv18629

Modified Files:
	badmagic.c bu_fgets.c fopen_uniq.c htond.c htonf.c ispar.c 
	linebuf.c list.c log.c magic.c mappedfile.c mread.c mro.c 
	observer.c parallel.c parse.c printb.c ptbl.c rb_internals.h 
	semaphore.c vfont.c vls.c 
Log Message:
Doxygen updates


Index: badmagic.c
===================================================================
RCS file: /cvsroot/brlcad/brlcad/src/libbu/badmagic.c,v
retrieving revision 14.10
retrieving revision 14.11
diff -w -u -r14.10 -r14.11
--- badmagic.c	31 Aug 2006 05:50:24 -0000	14.10
+++ badmagic.c	3 Sep 2006 15:14:07 -0000	14.11
@@ -22,6 +22,10 @@
 /** \addtogroup magic */
 /*@{*/
 /** @file badmagic.c
+ *
+ * @brief
+ * Routines to check magic numbers
+ *
  *  Routines involved with handling "magic numbers" used to identify
  *  various in-memory data structures.
  *

Index: bu_fgets.c
===================================================================
RCS file: /cvsroot/brlcad/brlcad/src/libbu/bu_fgets.c,v
retrieving revision 14.2
retrieving revision 14.3
diff -w -u -r14.2 -r14.3
--- bu_fgets.c	31 Aug 2006 05:50:24 -0000	14.2
+++ bu_fgets.c	3 Sep 2006 15:14:07 -0000	14.3
@@ -22,7 +22,7 @@
 /** \addtogroup bu_log */
 /*@{*/
 /** @file bu_fgets.c
- *
+ *@brief
  * fgets replacement function that also handles CR as an EOL marker
  *
  *  @Author John Anderson

Index: fopen_uniq.c
===================================================================
RCS file: /cvsroot/brlcad/brlcad/src/libbu/fopen_uniq.c,v
retrieving revision 14.13
retrieving revision 14.14
diff -w -u -r14.13 -r14.14
--- fopen_uniq.c	31 Aug 2006 05:50:24 -0000	14.13
+++ fopen_uniq.c	3 Sep 2006 15:14:07 -0000	14.14
@@ -22,10 +22,10 @@
 /** \addtogroup bu_log */
 /*@{*/
 /** @file fopen_uniq.c
- *  Routine to open a unique filename.
  *
- *  @author
- *	Lee A. Butler
+ * @brief Routine to open a unique filename.
+ *
+ *  @author Lee A. Butler
  *
  *  @par Source
  *	SECAD/VLD Computing Consortium, Bldg 394	@n

Index: htond.c
===================================================================
RCS file: /cvsroot/brlcad/brlcad/src/libbu/htond.c,v
retrieving revision 14.12
retrieving revision 14.13
diff -w -u -r14.12 -r14.13
--- htond.c	31 Aug 2006 23:16:38 -0000	14.12
+++ htond.c	3 Sep 2006 15:14:07 -0000	14.13
@@ -22,6 +22,8 @@
 /** \addtogroup hton */
 /*@{*/
 /** @file htond.c
+ *@brief convert doubles to host/network format
+ *
  *  Library routines for conversion between the local host
  *  64-bit ("double precision") representation, and
  *  64-bit IEEE double precision representation, in "network order",

Index: htonf.c
===================================================================
RCS file: /cvsroot/brlcad/brlcad/src/libbu/htonf.c,v
retrieving revision 14.12
retrieving revision 14.13
diff -w -u -r14.12 -r14.13
--- htonf.c	31 Aug 2006 23:16:38 -0000	14.12
+++ htonf.c	3 Sep 2006 15:14:07 -0000	14.13
@@ -22,6 +22,9 @@
 /** \addtogroup hton */
 /*@{*/
 /** @file htonf.c
+ *
+ *@brief convert floats to host/network format
+ *
  * Host to Network Floats  +  Network to Host Floats.
  *  Author -
  *	Michael John Muuss

Index: ispar.c
===================================================================
RCS file: /cvsroot/brlcad/brlcad/src/libbu/ispar.c,v
retrieving revision 14.13
retrieving revision 14.14
diff -w -u -r14.13 -r14.14
--- ispar.c	31 Aug 2006 23:16:38 -0000	14.13
+++ ispar.c	3 Sep 2006 15:14:07 -0000	14.14
@@ -22,6 +22,8 @@
 /** \addtogroup thread */
 /*@{*/
 /** @file ispar.c
+ * @brief subroutine to determine if we are multi-threaded
+ *
  *  This subroutine is separated off from parallel.c so that
  *  bu_bomb() and others can call it, without causing either
  *  parallel.c or semaphore.c to get referenced and thus causing

Index: linebuf.c
===================================================================
RCS file: /cvsroot/brlcad/brlcad/src/libbu/linebuf.c,v
retrieving revision 14.15
retrieving revision 14.16
diff -w -u -r14.15 -r14.16
--- linebuf.c	31 Aug 2006 23:16:38 -0000	14.15
+++ linebuf.c	3 Sep 2006 15:14:07 -0000	14.16
@@ -23,6 +23,9 @@
 /*@{*/
 
 /** @file linebuf.c
+ *
+ * @brief A portable way of doing setlinebuf().
+ *
  *	A portable way of doing setlinebuf().
  *
  *  @author	Doug A. Gwyn

Index: list.c
===================================================================
RCS file: /cvsroot/brlcad/brlcad/src/libbu/list.c,v
retrieving revision 14.10
retrieving revision 14.11
diff -w -u -r14.10 -r14.11
--- list.c	31 Aug 2006 23:16:38 -0000	14.10
+++ list.c	3 Sep 2006 15:14:07 -0000	14.11
@@ -22,6 +22,9 @@
 /** \addtogroup bu_list */
 /*@{*/
 /** @file ./libbu/list.c
+ *
+ * @brief Support routines for linked lists.
+ *
  *  Generic bu_list routines.
  *
  *  @author	Michael John Muuss

Index: log.c
===================================================================
RCS file: /cvsroot/brlcad/brlcad/src/libbu/log.c,v
retrieving revision 14.11
retrieving revision 14.12
diff -w -u -r14.11 -r14.12
--- log.c	31 Aug 2006 23:16:38 -0000	14.11
+++ log.c	3 Sep 2006 15:14:07 -0000	14.12
@@ -22,6 +22,8 @@
 /** \addtogroup bu_log */
 /*@{*/
 /** @file log.c
+ * @brief parallel safe version of fprintf for logging
+ *
  *  BRL-CAD support library, error logging routine.
  *  Note that the user may provide his own logging routine,
  *  by replacing these functions.  That is why this is in file of it's own.
@@ -34,10 +36,8 @@
  *
  * @par Specialty Functions -
  *	bu_log_add_hook		Start catching log events (used by mged/cmd.c)
- * @n	bu_log_delete_hook
  * @n	bu_putchar
  *
- *
  *  @author	Michael John Muuss
  *  @author	Glenn Durfee
  *

Index: magic.c
===================================================================
RCS file: /cvsroot/brlcad/brlcad/src/libbu/magic.c,v
retrieving revision 14.11
retrieving revision 14.12
diff -w -u -r14.11 -r14.12
--- magic.c	31 Aug 2006 23:16:38 -0000	14.11
+++ magic.c	3 Sep 2006 15:14:07 -0000	14.12
@@ -22,6 +22,9 @@
 /** \addtogroup magic */
 /*@{*/
 /** @file magic.c
+ *
+ *@brief routines for looking up magic numbers
+ *
  *  Routines involved with handling "magic numbers" used to identify
  *  various in-memory data structures.
  *

Index: mappedfile.c
===================================================================
RCS file: /cvsroot/brlcad/brlcad/src/libbu/mappedfile.c,v
retrieving revision 14.15
retrieving revision 14.16
diff -w -u -r14.15 -r14.16
--- mappedfile.c	31 Aug 2006 23:16:38 -0000	14.15
+++ mappedfile.c	3 Sep 2006 15:14:07 -0000	14.16
@@ -23,6 +23,8 @@
 /*@{*/
 
 /** @file mappedfile.c
+ * @brief Routines for sharing large read-only data files.
+ *
  *  Routines for sharing large read-only data files
  *  like height fields, bit map solids, texture maps, etc.
  *  Uses memory mapped files where available.

Index: mread.c
===================================================================
RCS file: /cvsroot/brlcad/brlcad/src/libbu/mread.c,v
retrieving revision 1.7
retrieving revision 1.8
diff -w -u -r1.7 -r1.8
--- mread.c	31 Aug 2006 23:16:38 -0000	1.7
+++ mread.c	3 Sep 2006 15:14:07 -0000	1.8
@@ -23,6 +23,8 @@
 /*@{*/
 /** @file mread.c
  *
+ * @brief multiple-read to fill a buffer
+ *
  * Provide a general means to a read some count of items from a file
  * descriptor reading multiple times until the quantity desired is
  * obtained.  This is useful for pipes and network connections that

Index: mro.c
===================================================================
RCS file: /cvsroot/brlcad/brlcad/src/libbu/mro.c,v
retrieving revision 14.11
retrieving revision 14.12
diff -w -u -r14.11 -r14.12
--- mro.c	31 Aug 2006 23:16:38 -0000	14.11
+++ mro.c	3 Sep 2006 15:14:07 -0000	14.12
@@ -23,7 +23,7 @@
 /*@{*/
 
 /** @file mro.c
- *  The Multiply Represented Object package.
+ * @brief  The Multiply Represented Object package.
  *
  *
  *  @author	John R. Anderson

Index: observer.c
===================================================================
RCS file: /cvsroot/brlcad/brlcad/src/libbu/observer.c,v
retrieving revision 14.12
retrieving revision 14.13
diff -w -u -r14.12 -r14.13
--- observer.c	31 Aug 2006 23:16:38 -0000	14.12
+++ observer.c	3 Sep 2006 15:14:07 -0000	14.13
@@ -23,7 +23,7 @@
 /*@{*/
 
 /** @file observer.c
- * Routines for implementing the observer pattern.
+ * @brief Routines for implementing the observer pattern.
  *
  * @par Source
  *	SLAD CAD Team

Index: parallel.c
===================================================================
RCS file: /cvsroot/brlcad/brlcad/src/libbu/parallel.c,v
retrieving revision 14.21
retrieving revision 14.22
diff -w -u -r14.21 -r14.22
--- parallel.c	31 Aug 2006 23:16:38 -0000	14.21
+++ parallel.c	3 Sep 2006 15:14:07 -0000	14.22
@@ -23,6 +23,9 @@
 /*@{*/
 
 /** @file parallel.c
+ *
+ * @brief routines for parallel processing
+ *
  *  Machine-specific routines for parallel processing.
  *  Primarily calling functions in multiple threads on multiple CPUs.
  *

Index: parse.c
===================================================================
RCS file: /cvsroot/brlcad/brlcad/src/libbu/parse.c,v
retrieving revision 14.12
retrieving revision 14.13
diff -w -u -r14.12 -r14.13
--- parse.c	31 Aug 2006 23:16:38 -0000	14.12
+++ parse.c	3 Sep 2006 15:14:07 -0000	14.13
@@ -23,6 +23,9 @@
 /*@{*/
 
 /** @file ./libbu/parse.c
+ *
+ * @brief routines for parsing arbitrary structures
+ *
  *  Routines to assign values to elements of arbitrary structures.
  *  The layout of a structure to be processed is described by
  *  a structure of type "bu_structparse", giving element names, element

Index: printb.c
===================================================================
RCS file: /cvsroot/brlcad/brlcad/src/libbu/printb.c,v
retrieving revision 14.12
retrieving revision 14.13
diff -w -u -r14.12 -r14.13
--- printb.c	31 Aug 2006 23:16:38 -0000	14.12
+++ printb.c	3 Sep 2006 15:14:07 -0000	14.13
@@ -23,6 +23,7 @@
 /*@{*/
 
 /** @file printb.c
+ * @brief print bitfields
  *
  *
  * @author	Michael John Muuss

Index: ptbl.c
===================================================================
RCS file: /cvsroot/brlcad/brlcad/src/libbu/ptbl.c,v
retrieving revision 14.11
retrieving revision 14.12
diff -w -u -r14.11 -r14.12
--- ptbl.c	31 Aug 2006 23:16:38 -0000	14.11
+++ ptbl.c	3 Sep 2006 15:14:07 -0000	14.12
@@ -23,6 +23,9 @@
 /*@{*/
 
 /** @file ptbl.c
+ *
+ * @brief Support for generalized "pointer tables"
+ *
  *  Support for generalized "pointer tables",
  *  kept compactly in a dynamic array.
  *

Index: rb_internals.h
===================================================================
RCS file: /cvsroot/brlcad/brlcad/src/libbu/rb_internals.h,v
retrieving revision 14.11
retrieving revision 14.12
diff -w -u -r14.11 -r14.12
--- rb_internals.h	18 Jan 2006 06:46:16 -0000	14.11
+++ rb_internals.h	3 Sep 2006 15:14:07 -0000	14.12
@@ -25,16 +25,15 @@
  *	The constants, macro functions, etc. need within LIBBU(3)
  *	to handle the red-black tree utilities.
  *
- *  Author -
+ *  @author
  *	Paul J. Tanenbaum
  *
- *  Source -
+ *  @par Source -
  *	The U. S. Army Research Laboratory
- *	Aberdeen Proving Ground, Maryland  21005-5068  USA
+ *@n	Aberdeen Proving Ground, Maryland  21005-5068  USA
  *
  *  $Header$
  */
-/*@}*/
 
 #include "compat4.h"
 
@@ -45,7 +44,7 @@
 #ifndef BU_RB_INTERNALS_H
 #define BU_RB_INTERNALS_H seen
 
-/*			B U _ R B _ C K M A G ( )
+/**			B U _ R B _ C K M A G ( )
  *	    Check and validate a structure pointer
  *
  *	This macro has three parameters: a pointer, the magic number
@@ -57,7 +56,7 @@
 #define	BU_RB_PKG_MAGIC		0x7262706b
 #define	BU_RB_LIST_MAGIC	0x72626c73
 
-/*			B U _ R B _ C K O R D E R ( )
+/**			B U _ R B _ C K O R D E R ( )
  *
  *	This macro has two parameters: a tree and an order number.
  *	It ensures that the order number is valid for the tree.
@@ -123,14 +122,14 @@
 #define	BU_RB_BLACK		1
 #define	bu_rb_data(n, o)	(((n) -> rbn_package)[o] -> rbp_data)
 
-/*
+/**
  *	Interface to _rb_walk()
  *	(Valid values for the parameter what_to_walk)
  */
 #define	WALK_NODES		0
 #define	WALK_DATA		1
 
-/*		    B U _ R B _ R O T A T E ( )
+/**		    B U _ R B _ R O T A T E ( )
  *			    and
  *		B U _ R B _ O T H E R _ R O T A T E ( )
  *
@@ -169,6 +168,7 @@
 BU_EXTERN(void bu_rb_free_package,	(struct bu_rb_package *package));
 
 #endif /* BU_RB_INTERNALS_H */
+/*@}*/
 
 /*
  * Local Variables:

Index: semaphore.c
===================================================================
RCS file: /cvsroot/brlcad/brlcad/src/libbu/semaphore.c,v
retrieving revision 14.13
retrieving revision 14.14
diff -w -u -r14.13 -r14.14
--- semaphore.c	31 Aug 2006 23:16:39 -0000	14.13
+++ semaphore.c	3 Sep 2006 15:14:07 -0000	14.14
@@ -22,6 +22,8 @@
 /** \addtogroup thread */
 /*@{*/
 /** @file semaphore.c
+ *@brief semaphore implementation
+ *
  *  Machine-specific routines for parallel processing.
  *  Primarily for handling semaphores for critical sections.
  *

Index: vfont.c
===================================================================
RCS file: /cvsroot/brlcad/brlcad/src/libbu/vfont.c,v
retrieving revision 14.14
retrieving revision 14.15
diff -w -u -r14.14 -r14.15
--- vfont.c	31 Aug 2006 23:16:39 -0000	14.14
+++ vfont.c	3 Sep 2006 15:14:07 -0000	14.15
@@ -22,18 +22,20 @@
 /** \addtogroup vfont */
 /*@{*/
 /** @file vfont.c
+ *
+ * @brief Berkely Vector Fonts
+ *
  *	Provide a machine-independent interface to files containing
  *	Berkeley VFONT format fonts, stored with VAX byte ordering
  *	and word alignment.
  *
- *  Author -
+ *  @author
  *	Michael John Muuss
  *
- *  Source -
+ *  @par Source -
  *	SECAD/VLD Computing Consortium, Bldg 394
- *	The U. S. Army Ballistic Research Laboratory
- *	Aberdeen Proving Ground, Maryland  21005-5066
- *
+ *@n	The U. S. Army Ballistic Research Laboratory
+ *@n	Aberdeen Proving Ground, Maryland  21005-5066
  */
 
 

Index: vls.c
===================================================================
RCS file: /cvsroot/brlcad/brlcad/src/libbu/vls.c,v
retrieving revision 14.19
retrieving revision 14.20
diff -w -u -r14.19 -r14.20
--- vls.c	31 Aug 2006 23:16:39 -0000	14.19
+++ vls.c	3 Sep 2006 15:14:07 -0000	14.20
@@ -22,6 +22,9 @@
 /** \addtogroup vls */
 /*@{*/
 /** @file vls.c
+ *
+ *  @brief The variable length string package.
+ *
  *  The variable length string package.
  *
  *  Assumption:  libc-provided sprintf() function is safe to use in parallel,