Index: trunk/archive/pslib/include/psPosition.h =================================================================== --- trunk/archive/pslib/include/psPosition.h (revision 149) +++ trunk/archive/pslib/include/psPosition.h (revision 153) @@ -7,13 +7,13 @@ /***********************************************************************************************************/ -/* Magic values for errors */ +/** Magic values for errors */ enum { - PS_NO_VALUE = -111.0, // Corresponding value not yet measured - PS_NO_ERROR = -222.0 // Corresponding value has no error + PS_NO_VALUE = -111.0, //!< Corresponding value not yet measured + PS_NO_ERROR = -222.0 //!< Corresponding value has no error }; /***********************************************************************************************************/ -/* Planets */ +/** Planets */ enum { PS_MERCURY = 1, @@ -27,36 +27,36 @@ } psPlanetNum; -/* Catalogues */ +/** Catalogues */ enum { - PS_PANSTARRS, // Pan-STARRS object catalogue - PS_USNO, // USNO-B1 catalogue - PS_2MASS, // 2MASS catalogue - PS_TYCHO, // Tycho catalogue - UCAC2 = 4 // UCAC2 catalogue + PS_PANSTARRS, //!< Pan-STARRS object catalogue + PS_USNO, //!< USNO-B1 catalogue + PS_2MASS, //!< 2MASS catalogue + PS_TYCHO, //!< Tycho catalogue + PS_UCAC2 = 4 //!< UCAC2 catalogue } psCatalogue; /***********************************************************************************************************/ -/* A position on a detector */ +/** A position on a detector */ typedef struct { - int chip; // Chip number - float x; // x position - float xErr; // Error in x position - float y; // y position - float yErr; // Error in y position + int chip; //!< Chip number + float x; //!< x position + float xErr; //!< Error in x position + float y; //!< y position + float yErr; //!< Error in y position } psOTAPos; -/* Constructor */ +/** Constructor */ psOTAPos * psOTAPosNew(void); -/* Destructor */ +/** Destructor */ void -psOTAPosDel(psOTAPos *restrict myOTAPos // Object to destroy +psOTAPosDel(psOTAPos *restrict myOTAPos //!< Object to destroy ); /***********************************************************************************************************/ -/* An array of detector positions */ +/** An array of detector positions */ PS_DECLARE_ARRAY_TYPE(psOTAPos); PS_CREATE_ARRAY_TYPE(psOTAPos); @@ -64,25 +64,27 @@ /***********************************************************************************************************/ -/* A simple RA/Dec position on the sky, default system is ICRS. */ -/* Double precision needed for milli-arcsec */ +/* + * \brief A simple RA/Dec position on the sky, default system is ICRS. Double precision needed for + * milli-arcsec. + */ typedef struct { - double ra; // Right Ascension - double raErr; // Error in RA - double dec; // Declination - double decErr; // Error in Dec + double ra; //!< Right Ascension + double raErr; //!< Error in RA + double dec; //!< Declination + double decErr; //!< Error in Dec } psSkyPos; -/* Constructor */ +/** Constructor */ psSkyPos * psSkyPosNew(void); -/* Destructor */ +/** Destructor */ void -psSkyPosDel(psSkyPos *restrict mySkyPos // Object to destroy +psSkyPosDel(psSkyPos *restrict mySkyPos //!< Object to destroy ); /***********************************************************************************************************/ -/* An array of sky positions */ +/** An array of sky positions */ PS_DECLARE_ARRAY_TYPE(psSkyPos); PS_CREATE_ARRAY_TYPE(psSkyPos); @@ -90,20 +92,19 @@ /***********************************************************************************************************/ -/* Latitude and Longitude. */ -/* Double precision needed for milli-arcsec */ +/** Latitude and Longitude. Double precision needed for milli-arcsec */ typedef struct { - double lat; // Latitude - double latErr; // Error in Latitude - double lng; // Longitude (can't use "long") - double lngErr; // Error in Longitude + double lat; //!< Latitude + double latErr; //!< Error in Latitude + double lng; //!< Longitude (can't use "long") + double lngErr; //!< Error in Longitude } psLatLong; -/* Constructor */ +/** Constructor */ psLatLong * psLatLongNew(void); -/* Destructor */ +/** Destructor */ void -psLatLongDel(psLatLong *restrict myLatLong // Object to destroy +psLatLongDel(psLatLong *restrict myLatLong //!< Object to destroy ); @@ -112,15 +113,14 @@ /* Offsets */ -/* Get offset (RA,Dec) on the sky between two positions */ -/* position1 and position2 may not be identical */ +/** Get offset (RA,Dec) on the sky between two positions position1 and position2 may not be identical */ psSkyPos * -psGetOffset(const psSkyPos *restrict position1, // Position 1 - const psSkyPos *restrict position2 // Position 2 +psGetOffset(const psSkyPos *restrict position1, //!< Position 1 + const psSkyPos *restrict position2 //!< Position 2 ); -/* Apply an offset to a position */ +/** Apply an offset to a position */ psSkyPos * -psApplyOffset(const psSkyPos *restrict position, // Position - const psSkyPos *restrict offset // Offset +psApplyOffset(const psSkyPos *restrict position, //!< Position + const psSkyPos *restrict offset //!< Offset ); @@ -129,34 +129,34 @@ /* Positions of well-known objects */ -/* Get Sun Position */ +/** Get Sun Position */ psSkyPos * -psGetSunPos(float mjd // MJD to get position for +psGetSunPos(float mjd //!< MJD to get position for ); -/* Get Moon position */ +/** Get Moon position */ psSkyPos * -psGetMoonPos(float mjd, // MJD to get position for - double latitude, // Latitude for apparent position - double longitude // Longitude for apparent position +psGetMoonPos(float mjd, //!< MJD to get position for + double latitude, //!< Latitude for apparent position + double longitude //!< Longitude for apparent position ); -/* Get Moon phase */ +/** Get Moon phase */ float -psGetMoonPhase(float mjd // MJD to get phase for +psGetMoonPhase(float mjd //!< MJD to get phase for ); -/* Get Planet positions */ +/** Get Planet positions */ psSkyPos * -psGetPlanetPos(enum psPlanetNum myPlanetNum, // Number for planet - float mjd // MJD to get position for +psGetPlanetPos(enum psPlanetNum myPlanetNum, //!< Number for planet + float mjd //!< MJD to get position for ); -/* Get star list from catalogue */ +/** Get star list from catalogue */ psObjectArray * -psReadStarCatalogue(double ra, // RA of centre of search - double dec, // Declination of centre of search - float radius, // Radius of search for stars in catalogue - float mjd, // The epoch (in MJD) for which to get positions - enum psCatalogue myCatalogue // The catalogue to use +psReadStarCatalogue(double ra, //!< RA of centre of search + double dec, //!< Declination of centre of search + float radius, //!< Radius of search for stars in catalogue + float mjd, //!< The epoch (in MJD) for which to get positions + enum psCatalogue myCatalogue //!< The catalogue to use ); @@ -165,22 +165,22 @@ /* Celestial coordinate conversions */ -/* Convert ICRS to Ecliptic */ +/** Convert ICRS to Ecliptic */ psLatLong * -psCoordinatesItoE(const psSkyPos *restrict coordinates // ICRS coordinates to convert +psCoordinatesItoE(const psSkyPos *restrict coordinates //!< ICRS coordinates to convert ); -/* Convert Ecliptic to ICRS */ +/** Convert Ecliptic to ICRS */ psSkyPos * -psCoordinatesEtoI(const psLatLong *restrict coordinates // Ecliptic coordinates to convert +psCoordinatesEtoI(const psLatLong *restrict coordinates //!< Ecliptic coordinates to convert ); -/* Convert ICRS to Galactic */ +/** Convert ICRS to Galactic */ psLatLong * -psCoordinatesItoG(const psSkyPos *restrict coordinates // ICRS coordinates to convert +psCoordinatesItoG(const psSkyPos *restrict coordinates //!< ICRS coordinates to convert ); -/* Convert Galactic to ICRS */ +/** Convert Galactic to ICRS */ psSkyPos * -psCoordinatesGtoI(const psLatLong *restrict coordinates // Galactic coordinates to convert +psCoordinatesGtoI(const psLatLong *restrict coordinates //!< Galactic coordinates to convert );