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

Timestamp:

Mar 23, 2004, 10:18:01 AM (22 years ago)

Author:

eugene

Message:

cleaned doxygen comments (one function description per function)
split psLibDesign appendix into group files & updated them

File:

• trunk/archive/pslib/include/psMetaData.h (modified) (1 diff)

trunk/archive/pslib/include/psMetaData.h

@@ -75 +75 @@
 /**** Utilities **********************************************************************/
 
+/// Add entry to the end of the metadata set
 psMetaDataItem *psMetaDataAppend(psMetaDataSet *restrict ms, psMetaDataItem *restrict item);
+
+/// delete entry from the metadata set
 psMetaDataItem *psMetaDataRemove(psMetaDataSet *restrict ms, const char *restrict key);
 
+/// reset the iterator to the start of the list
 void psMetaDataSetIterator(psMetaDataSet *ms);
+
+/// get the next entry in the sequence
 psMetaDataItem *psMetaDataGetNext(psMetaDataSet *restrict ms, const char *restrict match);
+
+/// find the metadata with the specified key
 psMetaDataItem *psMetaDataLookup(const psMetaDataSet *restrict ms, const char *restrict key);
 
+/// 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