Changeset 247 for trunk/archive/pslib/include/psMetaData.h

Timestamp:

Mar 15, 2004, 3:20:03 PM (22 years ago)

Author:

eugene

Message:

added Doxygen \file and \defgroup entries
some basic reorganization

File:

• trunk/archive/pslib/include/psMetaData.h (modified) (6 diffs)

trunk/archive/pslib/include/psMetaData.h

@@ -2 +2 @@
 #define PS_META_DATA_H 1
 
-#include "psImages.h"                   // for psImage
-#include "psAstrom.h"                   // for psAstrom
-/*
- * Possible types of metadata.  
+/** \file psMetaData.h
+ *  \brief Metadata handling structures and functions
+ *  \ingroup AstroGroup
  */
+
+/** Possible types of metadata. */
 typedef enum {                          // type of val is:
     PS_META_ITEM_SET = 0,               // NULL; metadata is in psMetaDataType.items
@@ -20 +21 @@
 } psMetaDataType;
 
+/** Metadata flags (not exclusive with psMetaDataType). */
 typedef enum {
     PS_META_TYPE_MASK =     0xffff,     // the type enum must fit in this mask
@@ -26 +28 @@
 } psMetaDataFlags;
 
-/*
- * A struct to define a single item of metadata
- */
+/** A struct to define a single item of metadata */
 typedef struct {
     const int id;                       // unique ID for this item
-    
     char *restrict name;                // Name of item
     psMetaDataType type;                // type of this item
@@ -44 +43 @@
 } psMetaDataItem;
 
-/*
- * A set of metadata
- */
+/** A set of metadata */
 typedef struct {
     psDlist *restrict list;             // list of psMetaDataItem
@@ -52 +49 @@
 } psMetaDataSet;
 
-/*****************************************************************************/
-/*
- * Constructors and destructors
- */
+/** Constructor */
 psMetaDataItem *psMetaDataItemAlloc(
     int typeFlags,                      // type of this piece of metadata + flags
@@ -65 +59 @@
     ...);                               // possible arguments for name format
 
+/** Destructor */
 void psMetaDataItemFree(psMetaDataItem *ms); // piece of metadata to destroy
 
+/** Constructor */
 psMetaDataSet *psMetaDataSetAlloc(void);   // make a new set of metadata
+
+/** Destructor */
 void psMetaDataSetFree(psMetaDataSet *ms); // destroy a set of metadata
 
-/*****************************************************************************/
-/*
- * Utilities
- */
+/**** Utilities **********************************************************************/
+
 psMetaDataItem *psMetaDataAppend(psMetaDataSet *restrict ms, psMetaDataItem *restrict item);
 psMetaDataItem *psMetaDataRemove(psMetaDataSet *restrict ms, const char *restrict key);