Minor improvements in code documentation.

Andreas Specovius · Jürgen Knödlseder
1 parent 0d4379fc
Showing 2 changed files with 8 additions and 3 deletions
include/GSkyRegionRect.hpp
src/sky/GSkyRegionRect.cpp
@@ -48,6 +48,9 @@
  * The class holds several properties such as solid angle subtended by the
  * region and computed through internal method compute_solid().
  *
+ * The position angle counts counter-clockwise from celestial North and is
+ * aligned with the height axis of the rectangle.
+ *
  ***************************************************************************/
 class GSkyRegionRect : public GSkyRegion {
@@ -258,7 +258,8 @@ GSkyRegionRect* GSkyRegionRect::clone(void) const
  * @param[in] posang Position angle [radians].
  *
  * Sets the position angle of the rectangular sky region. The position angle
- * is counted counterclockwise from North.
+ * is counted counterclockwise from cel. North and is aligned to the rect
+ * height.
  ***************************************************************************/
 void GSkyRegionRect::posang(const double& posang)
 {
@@ -279,7 +280,8 @@ void GSkyRegionRect::posang(const double&amp; posang)
  * @param[in] posang Position angle [degrees].
  *
  * Sets the position angle of the rectangular sky region. The position angle
- * is counted counterclockwise from North.
+ * is counted counterclockwise from cel. North and is aligned to the rect
+ * height.
  ***************************************************************************/
 void GSkyRegionRect::posang_deg(const double& posang)
 {
@@ -333,7 +335,7 @@ void GSkyRegionRect::width(const double&amp; width)
  *            Height value is less than 0.
  *
  * Sets the height of the rectangular sky region. Only non-negative radii are
- * allowed.
+ * allowed. For zero posang, the height axis is pointing to celestial north.
  ***************************************************************************/
 void GSkyRegionRect::height(const double& height)
 {