Changeset 153 for trunk/archive/pslib/include/psColour.h

Timestamp:

Mar 9, 2004, 12:28:16 PM (22 years ago)

Author:

Paul Price

Message:

Doxygen-ated the source files.

File:

• trunk/archive/pslib/include/psColour.h (modified) (1 diff)

trunk/archive/pslib/include/psColour.h

@@ -2 +2 @@
 #define PS_COLOUR_H
 
-/* Colour References */
 
-/*
- * Reference colours are roughly appropriate for a G5V star.  I get, with an arbitrary zero point, on the AB
- * system the following rough magnitudes: g = 1.36 mag, r = 0.84 mag, i = 0.72 mag, z = 0.69 mag, y = 0.69
- * mag, w = 0.80 mag
+/** Colour References.  Reference colours are roughly appropriate for a G5V star.  I get, with an arbitrary
+ * zero point, on the AB system the following rough magnitudes: g = 1.36 mag, r = 0.84 mag, i = 0.72 mag, z =
+ * 0.69 mag, y = 0.69 mag, w = 0.80 mag
  */
 enum {
-    PS_COLOUR_NO_INFO,                  // No colour information
-    PS_COLOUR_G_MINUS_R,                // Reference is g-r = 0.5 mag
-    PS_COLOUR_R_MINUS_I,                // Reference is r-i = 0.1 mag
-    PS_COLOUR_I_MINUS_Z,                // Reference is i-z = 0.0 mag
-    PS_COLOUR_Z_MINUS_Y,                // Reference is z-y = 0.0 mag
-    PS_COLOUR_R_MINUS_W                 // Reference is r-w = 0.0 mag
+    PS_COLOUR_NO_INFO,                  //!< No colour information
+    PS_COLOUR_G_MINUS_R,                //!< Reference is g-r = 0.5 mag
+    PS_COLOUR_R_MINUS_I,                //!< Reference is r-i = 0.1 mag
+    PS_COLOUR_I_MINUS_Z,                //!< Reference is i-z = 0.0 mag
+    PS_COLOUR_Z_MINUS_Y,                //!< Reference is z-y = 0.0 mag
+    PS_COLOUR_R_MINUS_W                 //!< Reference is r-w = 0.0 mag
 } psColourRef;