Changeset 5446 for trunk/psLib/src/astro/psEarthOrientation.h

Timestamp:

Oct 25, 2005, 3:20:15 PM (21 years ago)

Author:

drobbin

Message:

Finished and tested psGravityDeflection function

File:

• trunk/psLib/src/astro/psEarthOrientation.h (modified) (2 diffs)

trunk/psLib/src/astro/psEarthOrientation.h

@@ -6 +6 @@
 *  @ingroup EarthOrientation
 *
+*  @author Dave Robbins, MHPCC
 *  @author Robert Daniel DeSonia, MHPCC
 *
-*  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
-*  @date $Date: 2005-10-13 20:23:57 $
+*  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
+*  @date $Date: 2005-10-26 01:20:15 $
 *
 *  Copyright 2005 Maui High Performance Computing Center, University of Hawaii
@@ -55 +56 @@
 );
 
-/**
+/** Calculates the actual position of a star, given its apparent position and the
+ *  position of the sun.
  *
+ *  The actual and apparent positions are represented as psSphere entries, as is
+ *  position of the sun.  If the value of actual is NULL, a new psSphere is allocated,
+ *  otherwise the point to actual is used for the result.
  *
- *
+ *  @return psSphere*:      the apparent position of a star.
  */
 psSphere *psGravityDeflection(
-    psSphere *apparent,                ///<
-    psSphere *actual,                  ///<
-    psSphere *sun                      ///<
+    psSphere *apparent,                ///< apparent position of star
+    psSphere *actual,                  ///< actual position of star
+    psSphere *sun                      ///< position of the sun
 );