Changeset 4610

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

Files:

• sys/psTrace.h (modified) (5 diffs)
• types/psBitSet.h (modified) (4 diffs)
• types/psMetadata.c (modified) (1 diff)
• types/psMetadata.h (modified) (5 diffs)

trunk/psLib/src/sys/psTrace.h

@@ -9 +9 @@
  *  @author GLG, MHPCC
  *
- *  @version $Revision: 1.34 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-06-28 20:17:52 $
+ *  @version $Revision: 1.35 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-07-26 00:44:44 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -51 +51 @@
         typedef struct p_psComponent
         {
-            const char *name;   // last part of name of component
-            psS32 level;   // trace level for this component
-            bool p_psSpecified;
-            psS32 n;    // number of subcomponents
-            struct p_psComponent* *subcomp;     // next level of subcomponents
+            const char *name;                  ///< last part of name of component
+            psS32 level;                       ///< trace level for this component
+            bool p_psSpecified;                ///< whether the component is specified
+            psS32 n;                           ///< number of subcomponents
+            struct p_psComponent* *subcomp;    ///< next level of subcomponents
         }
 p_psComponent;
 
+/** Sends a trace message. */
 #ifdef DOXYGEN
 void psTrace(
@@ -80 +81 @@
 #endif /* DOXYGEN */
 
-/// Set trace level
+/** Set trace level
+ *
+ *  @return psBool:       True if successful, otherwise false
+ */
 psBool psTraceSetLevel(
     const char *facil,                 ///< facilty of interest
@@ -86 +90 @@
 );
 
-/// Get the trace level
+/** Get the trace level
+ *
+ *  @return int:    Trace Level
+ */
 int psTraceGetLevel(
     const char *facil                  ///< facilty of interest
@@ -99 +106 @@
 /// Set the destination of future trace messages.
 void psTraceSetDestination(
-    FILE * fp                          ///<
+    FILE * fp                          ///< Pointer to file
 );
 
-/// Get the current destination for trace messages.
+/** Get the current destination for trace messages.
+ *
+ *  @return FILE*:      File Destination
+ */
 FILE *psTraceGetDestination(void);
 

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
 );