Changeset 4610 for trunk/psLib/src/types

Timestamp:

Jul 25, 2005, 2:44:45 PM (21 years ago)

Author:

drobbin

Message:

made some doxygen comments and formatting updates

Location:

trunk/psLib/src/types

Files:

• psBitSet.h (modified) (4 diffs)
• psMetadata.c (modified) (1 diff)
• psMetadata.h (modified) (5 diffs)

trunk/psLib/src/types/psBitSet.h

@@ -12 +12 @@
  *  @author Ross Harman, MHPCC
  *
- *  @version $Revision: 1.21 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-07-15 02:33:54 $
+ *  @version $Revision: 1.22 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-07-26 00:44:45 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -54 +54 @@
  *  @return  psBitSet* : Pointer to struct containing array of bits and size of array.
  */
-
-/*@null@*/
 psBitSet* psBitSetAlloc(
     long nalloc                            ///< Number of bits in psBitSet array
@@ -70 +68 @@
  */
 psBitSet* psBitSetSet(
-    /* @returned@ */
     psBitSet* bitSet,                  ///< Pointer to psBitSet to be set.
     long bit                           ///< Bit to be set.
@@ -96 +93 @@
  *  value of one, since that is the value that was set.
  *
- *  @return  int: Value of bit, either one or zero.
+ *  @return  bool:      True if successful, otherwise false
  */
 

trunk/psLib/src/types/psMetadata.c

@@ -12 +12 @@
 *  @author Ross Harman, MHPCC
 *
-*  @version $Revision: 1.73 $ $Name: not supported by cvs2svn $
-*  @date $Date: 2005-07-21 02:39:57 $
+*  @version $Revision: 1.74 $ $Name: not supported by cvs2svn $
+*  @date $Date: 2005-07-26 00:44:45 $
 *
 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii

trunk/psLib/src/types/psMetadata.h

@@ -11 +11 @@
 *  @author Ross Harman, MHPCC
 *
-*  @version $Revision: 1.55 $ $Name: not supported by cvs2svn $
-*  @date $Date: 2005-07-21 02:39:57 $
+*  @version $Revision: 1.56 $ $Name: not supported by cvs2svn $
+*  @date $Date: 2005-07-26 00:44:45 $
 *
 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -238 +238 @@
 psMetadataItem* psMetadataItemAllocV(
     const char *name,                  ///< Name of metadata item.
-    psDataType type,               ///< Type of metadata item.
+    psDataType type,                   ///< Type of metadata item.
     const char *comment,               ///< Comment for metadata item.
     va_list list                       ///< Arguments for name formatting and metadata item data.
@@ -329 +329 @@
 bool psMetadataAddF64(
     psMetadata* md,                    ///< Metadata collection to insert metadata item
-    long location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
+    long location,                     ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     const char* name,                  ///< Name of metadata item
     const char* comment,               ///< Comment for metadata item
@@ -401 +401 @@
 psBool psMetadataAddHash(
     psMetadata* md,                    ///< Metadata collection to insert metadata item
-    long location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
+    long location,                     ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
     const char* name,                  ///< Name of metadata item
     const char* comment,               ///< Comment for metadata item
@@ -551 +551 @@
 psMetadataItem* psMetadataGet(
     const psMetadata* md,              ///< Metadata collection to retrieve metadata item.
-    int location                      ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
+    int location                       ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
 );