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

Timestamp:

Mar 31, 2004, 5:01:04 PM (22 years ago)

Author:

Paul Price

Message:

Standardised on /< as Doxygen comment for variable.

File:

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

trunk/archive/pslib/include/psMetaData.h

@@ -8 +8 @@
 
 /** Possible types of metadata. */
-typedef enum {                          //!< type of val is:
-    PS_META_ITEM_SET = 0,               //!< NULL; metadata is in psMetaDataType.items
-    PS_META_FLOAT,                      //!< float (.f)
-    PS_META_INT,                        //!< int (.i)
-    PS_META_STR,                        //!< string (.v)
-    PS_META_IMG,                        //!< image (.v)
-    PS_META_JPEG,                       //!< JPEG (.v)
-    PS_META_PNG,                        //!< PNG (.v)
-    PS_META_ASTROM,                     //!< astrometric coefficients (.v)
-    PS_META_UNKNOWN,                    //!< other (.v)
-    PS_META_NTYPE                       //!< Number of types; must be last
+typedef enum {                          ///< type of val is:
+    PS_META_ITEM_SET = 0,               ///< NULL; metadata is in psMetaDataType.items
+    PS_META_FLOAT,                      ///< float (.f)
+    PS_META_INT,                        ///< int (.i)
+    PS_META_STR,                        ///< string (.v)
+    PS_META_IMG,                        ///< image (.v)
+    PS_META_JPEG,                       ///< JPEG (.v)
+    PS_META_PNG,                        ///< PNG (.v)
+    PS_META_ASTROM,                     ///< astrometric coefficients (.v)
+    PS_META_UNKNOWN,                    ///< other (.v)
+    PS_META_NTYPE                       ///< Number of types; must be last
 } psMetaDataType;
 
 /** Metadata flags (not exclusive with psMetaDataType). */
 typedef enum {
-    PS_META_TYPE_MASK =     0xffff,     //!< the type enum must fit in this mask
-    PS_META_UNIQUE =       0x10000,     //!< the name must be unique (default)
-    PS_META_NON_UNIQUE =   0x20000,     //!< the name may be repeated, and should be disambiguated for us
+    PS_META_TYPE_MASK =     0xffff,     ///< the type enum must fit in this mask
+    PS_META_UNIQUE =       0x10000,     ///< the name must be unique (default)
+    PS_META_NON_UNIQUE =   0x20000,     ///< the name may be repeated, and should be disambiguated for us
 } psMetaDataFlags;
 
 /** 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
-    psMetaDataFlags flags;              //!< flags associated with this item
+    const int id;                       ///< unique ID for this item
+    char *restrict name;                ///< Name of item
+    psMetaDataType type;                ///< type of this item
+    psMetaDataFlags flags;              ///< flags associated with this item
     const union {
-        float f;                        //!< floating value
-        int i;                          //!< integer value
-        void *v;                        //!< other type
-    } val;                              //!< value of metadata
-    char *comment;                      //!< optional comment ("", not NULL)
-    psDlist *restrict items;            //!< list of psMetaDataItems with the same name
+        float f;                        ///< floating value
+        int i;                          ///< integer value
+        void *v;                        ///< other type
+    } val;                              ///< value of metadata
+    char *comment;                      ///< optional comment ("", not NULL)
+    psDlist *restrict items;            ///< list of psMetaDataItems with the same name
 } psMetaDataItem;
 
 /** A set of metadata */
 typedef struct {
-    psDlist *restrict list;             //!< list of psMetaDataItem
-    psHash *restrict table;             //!< hash table of the same metadata
+    psDlist *restrict list;             ///< list of psMetaDataItem
+    psHash *restrict table;             ///< hash table of the same metadata
 } psMetaDataSet;
 
@@ -55 +55 @@
 
 /** Constructor */
-psMetaDataItem *psMetaDataItemAlloc(int typeFlags, //!< type of this piece of metadata + flags
-                                    const void *val, //!< value of new item N.b. a pointer even if the item
-                                                     //!< is of type e.g. int
-                                    const char *comment, //!< comment associated with item
-                                    const char *name, //!< name of new item of metadata (may be in sprintf
-                                                      //!< format)
-                                    ... //!< possible arguments for name format
+psMetaDataItem *psMetaDataItemAlloc(int typeFlags, ///< type of this piece of metadata + flags
+                                    const void *val, ///< value of new item N.b. a pointer even if the item
+                                                     ///< is of type e.g. int
+                                    const char *comment, ///< comment associated with item
+                                    const char *name, ///< name of new item of metadata (may be in sprintf
+                                                      ///< format)
+                                    ... ///< possible arguments for name format
     );
 
 /** Destructor */
-void psMetaDataItemFree(psMetaDataItem *ms //!< piece of metadata to destroy
+void psMetaDataItemFree(psMetaDataItem *ms ///< piece of metadata to destroy
     );
 /** Constructor */
-psMetaDataSet *psMetaDataSetAlloc(void);   //!< make a new set of metadata
+psMetaDataSet *psMetaDataSetAlloc(void);   ///< make a new set of metadata
 
 /** Destructor */
-void psMetaDataSetFree(psMetaDataSet *ms //!< destroy a set of metadata
+void psMetaDataSetFree(psMetaDataSet *ms ///< destroy a set of metadata
     );
 
@@ -77 +77 @@
 
 /// Add entry to the end of the metadata set
-psMetaDataItem *psMetaDataAppend(psMetaDataSet *restrict ms, //!< Metadata set to add to
-                                 psMetaDataItem *restrict item //!< Metatdata to add
+psMetaDataItem *psMetaDataAppend(psMetaDataSet *restrict ms, ///< Metadata set to add to
+                                 psMetaDataItem *restrict item ///< Metatdata to add
     );
 
 /// delete entry from the metadata set
-psMetaDataItem *psMetaDataRemove(psMetaDataSet *restrict ms, //!< Metadata set to delete from
-                                 const char *restrict key //!< Key to delete
+psMetaDataItem *psMetaDataRemove(psMetaDataSet *restrict ms, ///< Metadata set to delete from
+                                 const char *restrict key ///< Key to delete
     );
 
 /// reset the iterator to the start of the list
-void psMetaDataSetIterator(psMetaDataSet *ms //!< Metadata set to set iterator for
+void psMetaDataSetIterator(psMetaDataSet *ms ///< Metadata set to set iterator for
     );
 
 /// get the next entry in the sequence
-psMetaDataItem *psMetaDataGetNext(psMetaDataSet *restrict ms, //!< Metadata set to get from
-                                  const char *restrict match //!< Match this
+psMetaDataItem *psMetaDataGetNext(psMetaDataSet *restrict ms, ///< Metadata set to get from
+                                  const char *restrict match ///< Match this
     );
 
 /// find the metadata with the specified key
-psMetaDataItem *psMetaDataLookup(const psMetaDataSet *restrict ms, //!< Metadata set to look up
-                                 const char *restrict key //!< Key to find
+psMetaDataItem *psMetaDataLookup(const psMetaDataSet *restrict ms, ///< Metadata set to look up
+                                 const char *restrict key ///< Key to find
     );
 
 /// print metadata item to the specified stream
-void psMetaDataItemPrint(FILE *fd,              //!< file descriptor to write to
-                         const psMetaDataItem *restrict ms, //!< item of metadata to print
-                         const char *prefix        //!< print this at the beginning of each line
+void psMetaDataItemPrint(FILE *fd,              ///< file descriptor to write to
+                         const psMetaDataItem *restrict ms, ///< item of metadata to print
+                         const char *prefix        ///< print this at the beginning of each line
     );
 /* \} */ // End of AstroGroup Functions