Changeset 344 for trunk/archive/pslib/include/psBitMask.h

Timestamp:

Mar 31, 2004, 5:01:04 PM (22 years ago)

Author:

Paul Price

Message:

Standardised on /< as Doxygen comment for variable.

File:

• trunk/archive/pslib/include/psBitMask.h (modified) (3 diffs)

trunk/archive/pslib/include/psBitMask.h

@@ -9 +9 @@
 /** A bitmask of arbitrary length. */
 typedef struct {
-    int n;                              //!< Number of chars that form the mask
-    char *bits;                         //!< The bits
+    int n;                              ///< Number of chars that form the mask
+    char *bits;                         ///< The bits
 } psBitMask;
 
@@ -19 +19 @@
 
 /** Constructor */
-psBitMask *psBitMaskAlloc(int n         //!< Number of bits required
+psBitMask *psBitMaskAlloc(int n         ///< Number of bits required
     );
 
 /** Destructor */
-void psBitMaskFree(psBitMask *restrict myMask //!< Bit mask to destroy
+void psBitMaskFree(psBitMask *restrict myMask ///< Bit mask to destroy
     );
 
@@ -30 +30 @@
 /** Set a bit mask */
 psBitMask *
-psBitMaskSet(psBitMask *outMask,        //!< Output bit mask or NULL
-             const psBitMask *myMask,   //!< Input bit mask
-             int bit                    //!< Bit to set
+psBitMaskSet(psBitMask *outMask,        ///< Output bit mask or NULL
+             const psBitMask *myMask,   ///< Input bit mask
+             int bit                    ///< Bit to set
     );
 
 /** Check a bit mask.  Returns true or false */
 int
-psBitMaskTest(const psBitMask *checkMask, //!< Bit mask to check
-              int bit                   //!< Bit to check
+psBitMaskTest(const psBitMask *checkMask, ///< Bit mask to check
+              int bit                   ///< Bit to check
     );
 
 /** apply the given operator to two bit masks */
 psBitMask *
-psBitMaskOp(psBitMask *outMask,         //!< Output bit mask or NULL
-            const psBitMask *restrict inMask1, //!< Input bit mask 1
-            char *operator,             //!< bit mask operator (AND, OR, XOR)
-            const psBitMask *restrict inMask2 //!< Input bit mask 2
+psBitMaskOp(psBitMask *outMask,         ///< Output bit mask or NULL
+            const psBitMask *restrict inMask1, ///< Input bit mask 1
+            char *operator,             ///< bit mask operator (AND, OR, XOR)
+            const psBitMask *restrict inMask2 ///< Input bit mask 2
     );