Changeset 11248 for trunk/psLib/src/math/psConstants.h

Timestamp:

Jan 23, 2007, 12:47:23 PM (19 years ago)

Author:

magnier

Message:

major cleanup of the Doxygen groups

File:

• trunk/psLib/src/math/psConstants.h (modified) (2 diffs)

trunk/psLib/src/math/psConstants.h

@@ -1 @@
-/** @file  psConstants.h
+/* @file  psConstants.h
  *
- *  This file will hold definitions of various constants as well as common
- *  macros used throughout psLib.
+ * @brief Definitions of various constants and common macros
  *
- *  @author GLG, MHPCC
+ * @author GLG, MHPCC
  *
- *  @version $Revision: 1.94 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2006-10-17 01:34:45 $
+ * @version $Revision: 1.95 $ $Name: not supported by cvs2svn $
+ * @date $Date: 2007-01-23 22:47:23 $
  *
- *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
+ * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
  *
- *  XXX: Add parenthesis around all arguments so that these macros can be
- *       called with complex expressions.
+ * XXX: Add parenthesis around all arguments so that these macros can be
+ *      called with complex expressions.
  *
- *  XXX: All functions which use the PS_ASSERT macros must be scrutinized so
- *  that we ensure that an argument which is expected to be output is
- *  psFree'ed before reurning NULL.
+ * XXX: All functions which use the PS_ASSERT macros must be scrutinized so
+ * that we ensure that an argument which is expected to be output is
+ * psFree'ed before reurning NULL.
  *
- *  XXX: The macros have a name similar to PS_CHECK_CONDITION() and generally
- *  throw a psError if the CONDITION is true.  However, some throw the error
- *  if the CONDITION is false.  This should be consistant.
+ * XXX: The macros have a name similar to PS_CHECK_CONDITION() and generally
+ * throw a psError if the CONDITION is true.  However, some throw the error
+ * if the CONDITION is false.  This should be consistant.
  *
  */
+
+#ifndef PS_CONSTANTS_H
+#define PS_CONSTANTS_H
+
+/// @addtogroup MathOps Mathematical Operations
+/// @{
 
 #include <math.h> // for M_PI
@@ -62 +67 @@
 #define PS_NOT_U16(A)(USHORT_MAX-(A)) // Perform bitwaise NOT on A which is of type U16
 
+/// @}
+#endif