Changeset 153 for trunk/archive/pslib/include/psBitMask.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/psBitMask.h (modified) (1 diff)

trunk/archive/pslib/include/psBitMask.h

@@ -2 +2 @@
 #define PS_BIT_MASK_H
 
-/* Type for a big bitmask */
-/* Set to long int for now */
+/** Type for a big bitmask.  Set to long int for now. */
 typedef long int psBitMask;
 
 
-/* Set a bit mask */
+/** Set a bit mask */
 psBitMask *
-psSetBitMask(psBitMask *outMask,        // Output bit mask or NULL
-             const psBitMask *myMask,   // Input bit mask
-             int bit                    // Bit to set
+psSetBitMask(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 */
+/** Check a bit mask.  Returns true or false */
 int
-psCheckBitMask(const psBitMask *checkMask, // Bit mask to check
-               int bit                  // Bit to check
+psCheckBitMask(const psBitMask *checkMask, //!< Bit mask to check
+               int bit                  //!< Bit to check
     );
 
-/* OR two bit masks */
+/** OR two bit masks */
 psBitMask *
-psOrBitMasks(psBitMask *outMask,        // Output bit mask or NULL
-             const psBitMask *restrict inMask1, // Input bit mask 1
-             const psBitMask *restrict inMask2 // Input bit mask 2
+psOrBitMasks(psBitMask *outMask,        //!< Output bit mask or NULL
+             const psBitMask *restrict inMask1, //!< Input bit mask 1
+             const psBitMask *restrict inMask2 //!< Input bit mask 2
     );
 
-/* AND two bit masks */
+/** AND two bit masks */
 psBitMask *
-psAndBitMasks(psBitMask *outMask,       // Output bit mask or NULL
-             const psBitMask *restrict inMask1, // Input bit mask 1
-             const psBitMask *restrict inMask2 // Input bit mask 2
+psAndBitMasks(psBitMask *outMask,       //!< Output bit mask or NULL
+             const psBitMask *restrict inMask1, //!< Input bit mask 1
+             const psBitMask *restrict inMask2 //!< Input bit mask 2
     );