IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Aug 3, 2004, 2:55:17 PM (22 years ago)
Author:
desonia
Message:

doxygen grouping tweaks.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/psLib/src/collections/psMetadata.h

    r1351 r1374  
    1010*  @author Ross Harman, MHPCC
    1111*
    12 *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
    13 *  @date $Date: 2004-07-30 19:37:07 $
     12*  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
     13*  @date $Date: 2004-08-04 00:55:17 $
    1414*
    1515*  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
     
    1818#define PS_METADATA_H
    1919
    20 
    2120/// @addtogroup Metadata
    2221/// @{
     
    3029 */
    3130typedef enum {
    32     PS_META_ITEM_SET = 0,                ///< Null. Metadata is in psMetadataItem.items
    33     PS_META_S32,                         ///< Signed 32-bit integer data.
    34     PS_META_F32,                         ///< Single-precision float data.
    35     PS_META_F64,                         ///< Double-precision float data.
    36     PS_META_STR,                         ///< String data (Stored in as void *).
    37     PS_META_IMG,                         ///< Image data (Stored in as void *).
    38     PS_META_JPEG,                        ///< JPEG data (Stored in as void .
    39     PS_META_PNG,                         ///< PNG data (Stored in as void *).
    40     PS_META_ASTROM,                      ///< Astrometric coefficients (Stored in as void *).
    41     PS_META_UNKNOWN,                     ///< Other data (Stored in as void *).
     31    PS_META_ITEM_SET = 0,                 ///< Null. Metadata is in psMetadataItem.items
     32    PS_META_S32,                          ///< Signed 32-bit integer data.
     33    PS_META_F32,                          ///< Single-precision float data.
     34    PS_META_F64,                          ///< Double-precision float data.
     35    PS_META_STR,                          ///< String data (Stored in as void *).
     36    PS_META_IMG,                          ///< Image data (Stored in as void *).
     37    PS_META_JPEG,                         ///< JPEG data (Stored in as void .
     38    PS_META_PNG,                          ///< PNG data (Stored in as void *).
     39    PS_META_ASTROM,                       ///< Astrometric coefficients (Stored in as void *).
     40    PS_META_UNKNOWN,                      ///< Other data (Stored in as void *).
    4241    PS_META_NTYPE                       ///< Number of types. Must be last.
    4342} psMetadataType;
     
    9796 */
    9897psMetadataItem *psMetadataItemAlloc(
    99     const char *name,                    ///< Name of metadata item.
    100     psMetadataType type,                 ///< Type of metadata item.
    101     const char *comment,                 ///< Comment for metadata item.
     98    const char *name,                     ///< Name of metadata item.
     99    psMetadataType type,                  ///< Type of metadata item.
     100    const char *comment,                  ///< Comment for metadata item.
    102101    ...                                 ///< Arguments for name formatting and metadata item data.
    103102);
     
    117116 */
    118117psMetadataItem *psMetadataItemAllocV(
    119     const char *name,                    ///< Name of metadata item.
    120     psMetadataType type,                 ///< Type of metadata item.
    121     const char *comment,                 ///< Comment for metadata item.
     118    const char *name,                     ///< Name of metadata item.
     119    psMetadataType type,                  ///< Type of metadata item.
     120    const char *comment,                  ///< Comment for metadata item.
    122121    va_list list                        ///< Arguments for name formatting and metadata item data.
    123122);
     
    140139 */
    141140bool psMetadataAddItem(
    142     psMetadata *restrict md,             ///< Metadata collection to insert metadat item.
    143     int where,                           ///< Location to be added.
     141    psMetadata *restrict md,              ///< Metadata collection to insert metadat item.
     142    int where,                            ///< Location to be added.
    144143    psMetadataItem *restrict item       ///< Metadata item to be added.
    145144);
     
    152151 */
    153152bool psMetadataAdd(
    154     psMetadata *restrict md,             ///< Metadata collection to insert metadat item.
    155     int where,                           ///< Location to be added.
    156     const char *name,                    ///< Name of metadata item.
    157     psMetadataType type,                 ///< Type of metadata item.
    158     const char *comment,                 ///< Comment for metadata item.
     153    psMetadata *restrict md,              ///< Metadata collection to insert metadat item.
     154    int where,                            ///< Location to be added.
     155    const char *name,                     ///< Name of metadata item.
     156    psMetadataType type,                  ///< Type of metadata item.
     157    const char *comment,                  ///< Comment for metadata item.
    159158    ...                                 ///< Arguments for name formatting and metadata item data.
    160159);
     
    170169 */
    171170bool psMetadataRemove(
    172     psMetadata *restrict md,             ///< Metadata collection to insert metadat item.
    173     int where,                           ///< Location to be removed.
     171    psMetadata *restrict md,              ///< Metadata collection to insert metadat item.
     172    int where,                            ///< Location to be removed.
    174173    const char *restrict key            ///< Name of metadata key.
    175174);
     
    183182 */
    184183psMetadataItem *psMetadataLookup(
    185     psMetadata *restrict md,             ///< Metadata collection to insert metadat item.
     184    psMetadata *restrict md,              ///< Metadata collection to insert metadat item.
    186185    const char *restrict key            ///< Name of metadata key.
    187186);
     
    194193 */
    195194psMetadataItem *psMetadataGet(
    196     psMetadata *restrict md,             ///< Metadata collection to insert metadat item.
     195    psMetadata *restrict md,              ///< Metadata collection to insert metadat item.
    197196    int where                           ///< Location to be retrieved.
    198197);
     
    205204 */
    206205bool psMetadataSetIterator(
    207     psMetadata *restrict md,             ///< Metadata collection to iterate.
     206    psMetadata *restrict md,              ///< Metadata collection to iterate.
    208207    int where                           ///< Location of iterator.
    209208);
     
    216215 */
    217216psMetadataItem *psMetadataGetNext(
    218     psMetadata *restrict md,             ///< Metadata collection to iterate.
    219     const char *restrict match,          ///< Beginning of key name.
     217    psMetadata *restrict md,              ///< Metadata collection to iterate.
     218    const char *restrict match,           ///< Beginning of key name.
    220219    int which                           ///< Iterator to be used.
    221220);
     
    228227 */
    229228psMetadataItem *psMetadataGetPrevious(
    230     psMetadata *restrict md,             ///< Metadata collection to iterate.
    231     const char *restrict match,          ///< Beginning of key name.
     229    psMetadata *restrict md,              ///< Metadata collection to iterate.
     230    const char *restrict match,           ///< Beginning of key name.
    232231    int which                           ///< Iterator to be used.
    233232);
     
    244243 */
    245244void psMetadataItemPrint(
    246     FILE *fd,                                    ///< Pointer to file to write metadata item.
    247     const char *format,                          ///< Format to print metadata item.
     245    FILE *fd,                                     ///< Pointer to file to write metadata item.
     246    const char *format,                           ///< Format to print metadata item.
    248247    const psMetadataItem *restrict metadataItem ///< Metadata item to print.
    249248);
     
    256255 */
    257256psMetadata *psMetadataReadHeader(
    258     psMetadata *output,                  ///< Resulting metadata from read.
    259     const char *extname,                 ///< File name extension string.
    260     int extnum,                          ///< File name extension number.
     257    psMetadata *output,                   ///< Resulting metadata from read.
     258    const char *extname,                  ///< File name extension string.
     259    int extnum,                           ///< File name extension number.
    261260    const char *filename                ///< Name of file to read.
    262261);
     
    269268 */
    270269psMetadata *psMetadataFReadHeader(
    271     psMetadata *output,                  ///< Resulting metadata from read.
    272     const char *extname,                 ///< File name extension string.
    273     int extnum,                          ///< File name extension number.
     270    psMetadata *output,                   ///< Resulting metadata from read.
     271    const char *extname,                  ///< File name extension string.
     272    int extnum,                           ///< File name extension number.
    274273    fitsfile *fd                        ///< Pointer to file to read.
    275274);
Note: See TracChangeset for help on using the changeset viewer.