Changeset 257 for trunk/archive/pslib/include/psMisc.h

Timestamp:

Mar 18, 2004, 9:37:58 PM (22 years ago)

Author:

eugene

Message:

code cleanup for Doxygen support & readability

File:

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

trunk/archive/pslib/include/psMisc.h

@@ -7 +7 @@
  */
 
-#define PS_STRING(S) #S                 //!< converts argument to string
+/** Functions **************************************************************/
+/** \addtogroup SystemGroup System Utilities
+ *  \{
+ */
 
-/** Prints an error message and aborts */
-void psAbort(const char *name,          //!< Category of code that caused the abort
-             const char *fmt,           //!< Format
-             ...                        //!< Extra arguments to use format
-    );
-/** Prints an error message and doesn't abort */
-void psError(const char *name,          //!< Category of code that caused the abort
-             const char *fmt,           //!< Format
-             ...                        //!< Extra arguments to use format
-    );
+/// Prints an error message and aborts
+void psAbort(const char *name,          ///< Category of code that caused the abort
+             const char *fmt,           ///< Format
+             ...)                       ///< Extra arguments to use format
+;
 
-/** Allocates and returns a copy of a string */
-char *psStringCopy(const char *str      //!< string to copy
-    );
+/// Prints an error message and doesn't abort
+void psError(const char *name,          ///< Category of code that caused the abort
+             const char *fmt,           ///< Format
+             ...)                       ///< Extra arguments to use format
+;
 
-/** Magic values for errors */
+/// Allocates and returns a copy of a string
+char *psStringCopy(const char *str)     ///< string to copy
+;
+
+/* \} */ // End of SystemGroup Functions
+
+#define PS_STRING(S) #S                 ///< converts argument to string
+
+/// Magic values for errors
 enum {
-    PS_NO_VALUE = -111,                 //!< Corresponding value not yet measured
-    PS_NO_ERROR = -222                  //!< Corresponding value has no error
+    PS_NO_VALUE = -111,                 ///< Corresponding value not yet measured
+    PS_NO_ERROR = -222                  ///< Corresponding value has no error
 };