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

Timestamp:

Mar 9, 2004, 5:19:15 PM (22 years ago)

Author:

Paul Price

Message:

Doxygenation of Lupton stuff partially complete. Still need to hack some more to conform everything to coding standards.

File:

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

trunk/archive/pslib/include/psMisc.h

@@ -1 +1 @@
 #if !defined(PS_MISC_H)
 #define PS_MISC_H
-/*
+/**
  * Concatenate two macro arguments
  */
-#define P_PS_CONCAT(A, B) A ## B        // Expands to AB
-#define PS_CONCAT(A, B) A ## B          // Also Expands to AB
-#define PS_CONCAT2(A, B) PS_CONCAT(A, B) // Also expands to AB
-#define PS_CONCAT3(A, B, C) A ## B ## C // Expands to ABC
-#define PS_CONCAT4(A, B, C, D) A ## B ## C ## D // Expands to ABCD
+#define P_PS_CONCAT(A, B) A ## B        //!< Expands to AB
+#define PS_CONCAT(A, B) A ## B          //!< Also Expands to AB
+#define PS_CONCAT2(A, B) PS_CONCAT(A, B) //!< Also expands to AB
+#define PS_CONCAT3(A, B, C) A ## B ## C //!< Expands to ABC
+#define PS_CONCAT4(A, B, C, D) A ## B ## C ## D //!< Expands to ABCD
 
-#define PS_STRING(S) #S                 // converts argument to string
+#define PS_STRING(S) #S                 //!< converts argument to string
 
-void psAbort(const char *name, const char *fmt, ...);
-void psError(const char *name, const char *fmt, ...);
+/** 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
+    );
 
-char *psStringCopy(const char *str);
+/** Allocates and returns a copy of a string */
+char *psStringCopy(const char *str      //!< string to copy
+    );
 
 #endif