docfix

robot0x · May 18, 2018 · c1f2ed1 · c1f2ed1
1 parent cb11bb8
commit c1f2ed1
Showing 1 changed file with 5 additions and 4 deletions.
diff --git a/src/core/RefractionExtinction.hpp b/src/core/RefractionExtinction.hpp
@@ -54,8 +54,8 @@ class Extinction
 
 	Extinction();
 
-	//! Compute extinction effect for arrays of size num position vectors and magnitudes.
-	//! @param altAzPos are the NORMALIZED (!!) (geometrical) star position vectors, and their z components sin(geometric_altitude).
+	//! Compute extinction effect for given position vector and magnitude.
+	//! @param altAzPos is the NORMALIZED (!!) (geometrical) star position vectors, and its z component is therefore sin(geometric_altitude).
 	//! This call must therefore be done before application of Refraction if atmospheric effects are on.
 	//! Note that forward/backward are no absolute reverse operations!
 	void forward(const Vec3d& altAzPos, float* mag) const
@@ -70,8 +70,9 @@ class Extinction
 		*mag += airmass(altAzPos[2], false) * ext_coeff;
 	}
 
-	//! Compute inverse extinction effect for arrays of size num position vectors and magnitudes.
-	//! @param altAzPos are the NORMALIZED (!!) (geometrical) star position vectors, and their z components sin(geometric_altitude).
+	//! Compute inverse extinction effect for given position vector and magnitude.
+	//! @param altAzPos is the NORMALIZED (!!) (geometrical) star position vector, and its z component is therefore sin(geometric_altitude).
+	//! This call must therefore be done after application of Refraction effects if atmospheric effects are on.
 	//! Note that forward/backward are no absolute reverse operations!
 	void backward(const Vec3d& altAzPos, float* mag) const
 	{