Changeset 1643

Timestamp:

Aug 27, 2004, 1:10:16 PM (22 years ago)

Author:

Paul Price

Message:

Getting rid of nasty "which" and "where", replaced with "iterator" and
"location", which are more descriptive.

File:

• trunk/archive/pslib/include/psMetadata.h (modified) (4 diffs)

trunk/archive/pslib/include/psMetadata.h

@@ -69 +69 @@
 /// Add item to the end of the metadata
 bool *psMetadataAddItem(psMetadata *md, ///< metadata to add to
-                                  int where, ///< Where to add item
-                                  psMetadataItem *item) ///< Metatdata item to add
+                        int location,   ///< Where to add item
+                        psMetadataItem *item) ///< Metatdata item to add
 ;
 
 /// Add item to the end of the metadata.  Combines psMetadataItemAlloc and psMetadataAppendItem
-bool *psMetadataAdd(psMetadata *md, ///< Metadata to add to
-                              int where, ///< Where to add item
-                              const char *name, ///< name of new item of metadata (sprintf format)
-                              int format, ///< type of this piece of metadata + flags
-                              const char *comment, ///< comment associated with item
-                              ...)      ///< possible arguments for name format
+bool *psMetadataAdd(psMetadata *md,     ///< Metadata to add to
+                    int location,       ///< Where to add item
+                    const char *name,   ///< name of new item of metadata (sprintf format)
+                    int format,         ///< type of this piece of metadata + flags
+                    const char *comment, ///< comment associated with item
+                    ...)                ///< possible arguments for name format
 ;
 
 /// delete item from the metadata
 bool *psMetadataRemove(psMetadata *md,  ///< metadata to delete from
-                       int where,       ///< Where to remove
+                       int location,    ///< Where to remove
                        const char *key  ///< Key to delete
     );
@@ -95 +95 @@
 /// retrieve the metadata on the basis of entry position
 psMetadataItem *psMetadataGet(const psMetadata *md, ///< metadata to look up
-                              int which ///< entry position
+                              int location ///< entry position
     );
 
 /// reset the iterator to the start of the list
 void psMetadataSetIterator(psMetadata *md, ///< metadata to set iterator for
-                           int which,   ///< Which iterator to set
-                           int where    ///< Where to set iterator
+                           int iterator, ///< Which iterator to set
+                           int location ///< Where to set iterator
                            );
 
@@ -107 +107 @@
 psMetadataItem *psMetadataGetNext(psMetadata *md, ///< metadata to get from
                                   const char *match, ///< String to match
-                                  int which ///< Which iterator to use
+                                  int iterator ///< Which iterator to use
     );
 
@@ -113 +113 @@
 psMetadataItem *psMetadataGetPrevious(psMetadata *md, ///< metadata to get from
                                       const char *match, ///< String to match
-                                      int which ///< Which iterator to use
+                                      int iterator ///< Which iterator to use
     );