Changeset 8224 for trunk/psLib/src/types

Timestamp:

Aug 7, 2006, 3:27:45 PM (20 years ago)

Author:

drobbin

Message:

Added psMetadataItemCompare test to tst_psMetadata_01.c and edited StringSub test to include MemCheckLeaks

Location:

trunk/psLib/src/types

Files:

• psMetadataItemCompare.c (modified) (2 diffs)
• psMetadataItemCompare.h (modified) (2 diffs)

trunk/psLib/src/types/psMetadataItemCompare.c

@@ -11 +11 @@
 
 bool psMetadataItemCompare(const psMetadataItem *compare, // Item to compare to the template
-                           const psMetadataItem *template // The template
-                          )
+                           const psMetadataItem *template) // The template
 {
 
@@ -54 +53 @@
 
     switch (template->type) {
-        TEMPLATE_CASE(BOOL, B  , psBool)
+        TEMPLATE_CASE(BOOL, B,   psBool)
         ;
-        TEMPLATE_CASE(U8,   U8 , psU8 );
+        TEMPLATE_CASE(U8,   U8,  psU8 );
         TEMPLATE_CASE(U16,  U16, psU16);
         TEMPLATE_CASE(U32,  U32, psU32);
-        TEMPLATE_CASE(S8 ,  S8 , psS8 );
+        TEMPLATE_CASE(S8,   S8,  psS8 );
         TEMPLATE_CASE(S16,  S16, psS16);
         TEMPLATE_CASE(S32,  S32, psS32);

trunk/psLib/src/types/psMetadataItemCompare.h

@@ +1 @@
+/** @file  psMetadataItemCompare.h
+ *
+ *  @brief Compares Metadata Items
+ *
+ *  This file defines functions to compare psMetadataItem's.
+ *
+ *  @ingroup Metadata
+ *
+ *  @author IFA
+ *
+ *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2006-08-08 01:27:45 $
+ *
+ *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
+ */
+
 #ifndef PS_METADATA_ITEM_COMPARE_H
 #define PS_METADATA_ITEM_COMPARE_H
@@ -4 +20 @@
 #include "psMetadata.h"
 
-bool psMetadataItemCompare(const psMetadataItem *compare, // Item to compare to the template
-                           const psMetadataItem *template // The template
-                          )
+/// @addtogroup Metadata
+/// @{
+
+/** Compares two psMetadataItems.
+ *
+ *  @return bool:       True if compare matches template, otherwise false.
+ */
+bool psMetadataItemCompare(
+    const psMetadataItem *compare,     ///< Item to compare to the template
+    const psMetadataItem *template     ///< The template
+)
 ;
 
 
+/// @}
+
 #endif