Changeset 4243 for trunk/psLib/src/xml/psXML.h

Timestamp:

Jun 13, 2005, 4:54:15 PM (21 years ago)

Author:

drobbin

Message:

* empty log message *

File:

• trunk/psLib/src/xml/psXML.h (modified) (2 diffs)

trunk/psLib/src/xml/psXML.h

@@ -10 +10 @@
  *  @author Robert DeSonia, MHPCC
  *
- *  @version $Revision: 1.12 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-06-10 18:09:12 $
+ *  @version $Revision: 1.13 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-06-14 02:54:07 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -21 +21 @@
 /// @{
 
+/** A metadata data structure used in parsing arrays.
+ *  
+ *  Contains array information and the metadata storage location.
+*/
 typedef struct
 {
-    psArray*    nonUniqueKeyArray;
-    psArray*    typeArray;
-    psArray*    templateArray;
-    psMetadata* metadata;
-    char*       name;
+    psArray*    nonUniqueKeyArray;     ///< non-unique key names
+    psArray*    typeArray;             ///< array of user defined types
+    psArray*    templateArray;         ///< array of user type templates
+    psMetadata* metadata;              ///< metadata container
+    char*       name;                  ///< name of key
 }
 p_psParseLevelInfo;
 
+/** Allocates a p_psParseLevelInfo structure
+ *   
+ *  @return p_psParseLevelInfo* :   new p_psParseLevelInfo struct
+ */
 p_psParseLevelInfo* p_psParseLevelInfoAlloc(void);