IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Changeset 4130


Ignore:
Timestamp:
Jun 7, 2005, 9:59:39 AM (21 years ago)
Author:
evanalst
Message:

Update doxygen comments for location argument.

Location:
trunk/psLib/src
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/psLib/src/collections/psMetadata.h

    r3945 r4130  
    1111*  @author Ross Harman, MHPCC
    1212*
    13 *  @version $Revision: 1.45 $ $Name: not supported by cvs2svn $
    14 *  @date $Date: 2005-05-16 19:43:53 $
     13*  @version $Revision: 1.46 $ $Name: not supported by cvs2svn $
     14*  @date $Date: 2005-06-07 19:59:39 $
    1515*
    1616*  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    260260    psMetadata*  md,                   ///< Metadata collection to insert metadat item.
    261261    psMetadataItem*  item,             ///< Metadata item to be added.
    262     psS32 location,                    ///< Location to be added.
     262    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
    263263    psS32 flags                        ///< Options flag mask, see psMetadataFlags enum
    264264);
    … …  
    272272psBool psMetadataAdd(
    273273    psMetadata* md,                    ///< Metadata collection to insert metadata item.
    274     psS32 location,                    ///< Location to be added.
     274    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
    275275    const char *name,                  ///< Name of metadata item.
    276276    int type,                          ///< Type of metadata item (psMetadataType) and options (psMetadataFlags)
    … …  
    288288psBool psMetadataAddV(
    289289    psMetadata* md,                    ///< Metadata collection to insert metadat item.
    290     psS32 location,                    ///< Location to be added.
     290    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
    291291    const char *name,                  ///< Name of metadata item.
    292292    int type,                          ///< Type of metadata item (psMetadataType) and options (psMetadataFlags)
    … …  
    331331psBool psMetadataRemove(
    332332    psMetadata*  md,           ///< Metadata collection to remove metadata item.
    333     psS32 where,               ///< Location to be removed.
     333    psS32 where,               ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
    334334    const char * key           ///< Name of metadata key.
    335335);
    … …  
    426426 */
    427427psMetadataItem* psMetadataGet(
    428     psMetadata*  md,                   ///< Metadata collection to insert metadat item.
    429     psS32 location                     ///< Location to be retrieved.
     428    psMetadata*  md,                   ///< Metadata collection to retrieve metadata item.
     429    psS32 location                     ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
    430430);
    431431
    … …  
    440440psMetadataIterator* psMetadataIteratorAlloc(
    441441    psMetadata* md,                    ///< the psMetadata to iterate with
    442     int location,                      ///< the initial starting point (after subsetting).
     442    int location,                      ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
    443443    const char* regex
    444444    ///< A regular expression for subsetting the psMetadata.  If NULL, no

  • trunk/psLib/src/types/psMetadata.h

    r3945 r4130  
    1111*  @author Ross Harman, MHPCC
    1212*
    13 *  @version $Revision: 1.45 $ $Name: not supported by cvs2svn $
    14 *  @date $Date: 2005-05-16 19:43:53 $
     13*  @version $Revision: 1.46 $ $Name: not supported by cvs2svn $
     14*  @date $Date: 2005-06-07 19:59:39 $
    1515*
    1616*  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    260260    psMetadata*  md,                   ///< Metadata collection to insert metadat item.
    261261    psMetadataItem*  item,             ///< Metadata item to be added.
    262     psS32 location,                    ///< Location to be added.
     262    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
    263263    psS32 flags                        ///< Options flag mask, see psMetadataFlags enum
    264264);
    … …  
    272272psBool psMetadataAdd(
    273273    psMetadata* md,                    ///< Metadata collection to insert metadata item.
    274     psS32 location,                    ///< Location to be added.
     274    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
    275275    const char *name,                  ///< Name of metadata item.
    276276    int type,                          ///< Type of metadata item (psMetadataType) and options (psMetadataFlags)
    … …  
    288288psBool psMetadataAddV(
    289289    psMetadata* md,                    ///< Metadata collection to insert metadat item.
    290     psS32 location,                    ///< Location to be added.
     290    psS32 location,                    ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
    291291    const char *name,                  ///< Name of metadata item.
    292292    int type,                          ///< Type of metadata item (psMetadataType) and options (psMetadataFlags)
    … …  
    331331psBool psMetadataRemove(
    332332    psMetadata*  md,           ///< Metadata collection to remove metadata item.
    333     psS32 where,               ///< Location to be removed.
     333    psS32 where,               ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
    334334    const char * key           ///< Name of metadata key.
    335335);
    … …  
    426426 */
    427427psMetadataItem* psMetadataGet(
    428     psMetadata*  md,                   ///< Metadata collection to insert metadat item.
    429     psS32 location                     ///< Location to be retrieved.
     428    psMetadata*  md,                   ///< Metadata collection to retrieve metadata item.
     429    psS32 location                     ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
    430430);
    431431
    … …  
    440440psMetadataIterator* psMetadataIteratorAlloc(
    441441    psMetadata* md,                    ///< the psMetadata to iterate with
    442     int location,                      ///< the initial starting point (after subsetting).
     442    int location,                      ///< Index number, PS_LIST_HEAD, or PS_LIST_TAIL
    443443    const char* regex
    444444    ///< A regular expression for subsetting the psMetadata.  If NULL, no
Note: See TracChangeset for help on using the changeset viewer.