Changeset 344 for trunk/archive/pslib/include/psPosition.h

Timestamp:

Mar 31, 2004, 5:01:04 PM (22 years ago)

Author:

Paul Price

Message:

Standardised on /< as Doxygen comment for variable.

File:

• trunk/archive/pslib/include/psPosition.h (modified) (6 diffs)

trunk/archive/pslib/include/psPosition.h

@@ -13 +13 @@
 typedef union {
     struct {
-        double x;                       //!< x position
-        double y;                       //!< y position
-        double xErr;                    //!< Error in x position
-        double yErr;                    //!< Error in y position
+        double x;                       ///< x position
+        double y;                       ///< y position
+        double xErr;                    ///< Error in x position
+        double yErr;                    ///< Error in y position
     } xy;
     struct {
-        double r;                       //!< RA
-        double d;                       //!< Dec
-        double rErr;                    //!< Error in RA
-        double dErr;                    //!< Error in Dec
+        double r;                       ///< RA
+        double d;                       ///< Dec
+        double rErr;                    ///< Error in RA
+        double dErr;                    ///< Error in Dec
     } rd;
 } psCoord;
@@ -48 +48 @@
 
 /** apply the coordinate transformation to the given coordinate */
-psCoord *psCoordXformApply (psCoord *out, //!< Output coordinates, or NULL
+psCoord *psCoordXformApply (psCoord *out, ///< Output coordinates, or NULL
                             const psCoordXform *frame, ///< coordinate transformation
                             const psCoord *coords ///< input coordiate
@@ -54 +54 @@
 
 /** apply the optical distortion to the given coordinate, magnitude, color */
-psCoord *psDistortionApply (psCoord *out, //!< Output coordinates, or NULL
+psCoord *psDistortionApply (psCoord *out, ///< Output coordinates, or NULL
                             const psdistortion *pattern, ///< optical distortion pattern
                             const psCoord *coords, ///< input coordinate
@@ -63 +63 @@
 /** Get offset (RA,Dec) on the sky between two positions position1 and position2 may not be identical */
 psCoord *
-psGetOffset(const psCoord *restrict position1, //!< Position 1
-            const psCoord *restrict position2, //!< Position 2
-            const char *type            //!< Type of offset: Linear, Spherical/Arcsec, Spherical/Degreees etc
+psGetOffset(const psCoord *restrict position1, ///< Position 1
+            const psCoord *restrict position2, ///< Position 2
+            const char *type            ///< Type of offset: Linear, Spherical/Arcsec, Spherical/Degreees etc
     );
 
 /** Apply an offset to a position */
 psCoord *
-psApplyOffset(const psCoord *restrict position, //!< Position
-              const psCoord *restrict offset, //!< Offset
-              const char *type          //!< Type of offset: Linear, Spherical/Arcsec, Spherical/Degreees etc
+psApplyOffset(const psCoord *restrict position, ///< Position
+              const psCoord *restrict offset, ///< Offset
+              const char *type          ///< Type of offset: Linear, Spherical/Arcsec, Spherical/Degreees etc
     );
 
@@ -79 +79 @@
 /** Get Sun Position */
 psCoord *
-psGetSunPos(float mjd                   //!< MJD to get position for
+psGetSunPos(float mjd                   ///< MJD to get position for
     );
 
 /** Get Moon position */
 psCoord *
-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 */
 float
-psGetMoonPhase(float mjd                //!< MJD to get phase for
+psGetMoonPhase(float mjd                ///< MJD to get phase for
     );
 
 /** Get Planet positions */
 psCoord *
-psGetSolarSystemPos(const char *solarSystemObject, //!< Named S.S. object
-                    float mjd           //!< MJD to get position for
+psGetSolarSystemPos(const char *solarSystemObject, ///< Named S.S. object
+                    float mjd           ///< MJD to get position for
     );
 
@@ -106 +106 @@
 /** Convert ICRS to Ecliptic */
 psCoord *
-psCoordinatesItoE(const psCoord *restrict coordinates //!< ICRS coordinates to convert
+psCoordinatesItoE(const psCoord *restrict coordinates ///< ICRS coordinates to convert
     );
 
 /** Convert Ecliptic to ICRS */
 psCoord *
-psCoordinatesEtoI(const psCoord *restrict coordinates //!< Ecliptic coordinates to convert
+psCoordinatesEtoI(const psCoord *restrict coordinates ///< Ecliptic coordinates to convert
     );
 
 /** Convert ICRS to Galactic */
 psCoord *
-psCoordinatesItoG(const psCoord *restrict coordinates //!< ICRS coordinates to convert
+psCoordinatesItoG(const psCoord *restrict coordinates ///< ICRS coordinates to convert
     );
 
 /** Convert Galactic to ICRS */
 psCoord *
-psCoordinatesGtoI(const psCoord *restrict coordinates //!< Galactic coordinates to convert
+psCoordinatesGtoI(const psCoord *restrict coordinates ///< Galactic coordinates to convert
     );