Changeset 4127

Timestamp:

Jun 6, 2005, 4:08:26 PM (21 years ago)

Author:

drobbin

Message:

* empty log message *

Location:

trunk/psLib/src

Files:

• astro/psCoord.h (modified) (4 diffs)
• astronomy/psCoord.h (modified) (4 diffs)

trunk/psLib/src/astro/psCoord.h

@@ -10 +10 @@
 *  @author GLG, MHPCC
 *
-*  @version $Revision: 1.31 $ $Name: not supported by cvs2svn $
-*  @date $Date: 2005-05-19 05:18:20 $
+*  @version $Revision: 1.32 $ $Name: not supported by cvs2svn $
+*  @date $Date: 2005-06-07 02:08:26 $
 *
 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -317 +317 @@
  *  specifies the units of the offset only.
  *
- *  @return psSphere*    the offset between position1 and position2
+ *  @return psSphere*        the offset between position1 and position2
  */
 psSphere* psSphereGetOffset(
-    const psSphere* position1,
-    const psSphere* position2,
-    psSphereOffsetMode mode,
-    psSphereOffsetUnit unit
+    const psSphere* position1,          ///< first position for calculating offset
+    const psSphere* position2,          ///< second position for calculating offset
+    psSphereOffsetMode mode,            ///< type of offset can be PS_SPHERICAL or PS_LINEAR
+    psSphereOffsetUnit unit             ///< specifies the units of offset only
 );
 
@@ -335 +335 @@
  *  specifies the units of the offset only.
  *
- *  @return psSphere*    the given position with the given offset applied.
+ *  @return psSphere*              the original position with the given offset applied.
  */
 psSphere* psSphereSetOffset(
-    const psSphere* position,
-    const psSphere* offset,
-    psSphereOffsetMode mode,
-    psSphereOffsetUnit unit
+    const psSphere* position,           ///< coordinate of origin
+    const psSphere* offset,             ///< coordinate of offset to apply
+    psSphereOffsetMode mode,            ///< corresponds to an offset in angles or local projection
+    psSphereOffsetUnit unit             ///< specifies the units of offset only
 );
 
@@ -355 +355 @@
 );
 
-// XXX: Doxygenate.
+/** Takes a given transform and inverts it linearly if possible.
+ *
+ *  @return psPlaneTransform           
+ *  the linearly inverted transform
+*/
 psPlaneTransform *p_psPlaneTransformLinearInvert(
-    psPlaneTransform *transform
-);
-
-// XXX: Doxygenate
+    psPlaneTransform *transform         ///<    transform to invert
+);
+
+
+/** Takes a transform and tests whether or not it is a linear projection.
+ *
+ *  @return psS32                      
+ *  the order of the projection
+*/
 psS32 p_psIsProjectionLinear(
-    psPlaneTransform *transform
+    psPlaneTransform *transform          ///<     transform to test for linearity
 );
 

trunk/psLib/src/astronomy/psCoord.h

@@ -10 +10 @@
 *  @author GLG, MHPCC
 *
-*  @version $Revision: 1.31 $ $Name: not supported by cvs2svn $
-*  @date $Date: 2005-05-19 05:18:20 $
+*  @version $Revision: 1.32 $ $Name: not supported by cvs2svn $
+*  @date $Date: 2005-06-07 02:08:26 $
 *
 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -317 +317 @@
  *  specifies the units of the offset only.
  *
- *  @return psSphere*    the offset between position1 and position2
+ *  @return psSphere*        the offset between position1 and position2
  */
 psSphere* psSphereGetOffset(
-    const psSphere* position1,
-    const psSphere* position2,
-    psSphereOffsetMode mode,
-    psSphereOffsetUnit unit
+    const psSphere* position1,          ///< first position for calculating offset
+    const psSphere* position2,          ///< second position for calculating offset
+    psSphereOffsetMode mode,            ///< type of offset can be PS_SPHERICAL or PS_LINEAR
+    psSphereOffsetUnit unit             ///< specifies the units of offset only
 );
 
@@ -335 +335 @@
  *  specifies the units of the offset only.
  *
- *  @return psSphere*    the given position with the given offset applied.
+ *  @return psSphere*              the original position with the given offset applied.
  */
 psSphere* psSphereSetOffset(
-    const psSphere* position,
-    const psSphere* offset,
-    psSphereOffsetMode mode,
-    psSphereOffsetUnit unit
+    const psSphere* position,           ///< coordinate of origin
+    const psSphere* offset,             ///< coordinate of offset to apply
+    psSphereOffsetMode mode,            ///< corresponds to an offset in angles or local projection
+    psSphereOffsetUnit unit             ///< specifies the units of offset only
 );
 
@@ -355 +355 @@
 );
 
-// XXX: Doxygenate.
+/** Takes a given transform and inverts it linearly if possible.
+ *
+ *  @return psPlaneTransform           
+ *  the linearly inverted transform
+*/
 psPlaneTransform *p_psPlaneTransformLinearInvert(
-    psPlaneTransform *transform
-);
-
-// XXX: Doxygenate
+    psPlaneTransform *transform         ///<    transform to invert
+);
+
+
+/** Takes a transform and tests whether or not it is a linear projection.
+ *
+ *  @return psS32                      
+ *  the order of the projection
+*/
 psS32 p_psIsProjectionLinear(
-    psPlaneTransform *transform
+    psPlaneTransform *transform          ///<     transform to test for linearity
 );