IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Changeset 1472


Ignore:
Timestamp:
Aug 11, 2004, 9:53:33 AM (22 years ago)
Author:
desonia
Message:

doxygen cleanup.

Location:
trunk/psLib/src
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/psLib/src/collections/psBitSet.h

    r1441 r1472  
    1313 *  @author Ross Harman, MHPCC
    1414 *
    15  *  @version $Revision: 1.12 $ $Name: not supported by cvs2svn $
    16  *  @date $Date: 2004-08-09 23:40:55 $
     15 *  @version $Revision: 1.13 $ $Name: not supported by cvs2svn $
     16 *  @date $Date: 2004-08-11 19:53:33 $
    1717 *
    1818 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    3838typedef struct
    3939{
    40 
    41     int n;      /**< Number of bytes in the array */
    42 
    43     char *bits; /**< Aray of bytes holding bits */
     40    int n;                             ///< Number of bytes in the array
     41    char *bits;                        ///< Aray of bytes holding bits
    4442}
    4543psBitSet;
    … …  
    6058
    6159/*@null@*/
    62 
    63 psBitSet* psBitSetAlloc(int n
    64                         /**< Number of bits in psBitSet array */
    65                        );
     60psBitSet* psBitSetAlloc(
     61    int n                              ///< Number of bits in psBitSet array
     62);
    6663
    6764/** Set a bit.
    … …  
    7471 */
    7572psBitSet* psBitSetSet(
    76 
    77     /* @returned@ */ psBitSet* restrict inMask,
    78     /**< Pointer to psBitSet to be set. */
    79 
    80     int bit/**< Bit to be set. */
     73    /* @returned@ */
     74    psBitSet* restrict inMask,         ///< Pointer to psBitSet to be set.
     75    int bit                            ///< Bit to be set.
    8176);
    8277
    … …  
    9186 */
    9287
    93 bool psBitSetTest(const psBitSet* restrict inMask,
    94                   /**< Pointer psBitSet to be tested. */
    95 
    96                   int bit               /**< Bit to be tested. */
    97                  );
     88bool psBitSetTest(
     89    const psBitSet* restrict inMask,   ///< Pointer psBitSet to be tested.
     90    int bit                            ///< Bit to be tested.
     91);
    9892
    9993/** Perform a binary operation on two psBitSets
    … …  
    10599 */
    106100psBitSet* psBitSetOp(
    107 
    108     /* @returned@ */ psBitSet* restrict outMask,
    109     /**< Resulting psBitSet from binary operation */
    110 
    111     const psBitSet* restrict inMask1,
    112     /**< First psBitSet on which to operate */
    113 
    114     char *operator,         /**< Bit operation */
    115 
    116     const psBitSet* restrict inMask2
    117     /**< First psBitSet on which to operate */
     101    /* @returned@ */
     102    psBitSet* restrict outMask,        ///< Resulting psBitSet from binary operation
     103    const psBitSet* restrict inMask1,  ///< First psBitSet on which to operate
     104    char *operator,                    ///< Bit operation
     105    const psBitSet* restrict inMask2   ///< First psBitSet on which to operate
    118106);
    119107
    … …  
    125113 */
    126114
    127 psBitSet* psBitSetNot(psBitSet* outBitSet,
    128                       /**< Resulting psBitSet from operation */
    129 
    130                       const psBitSet* restrict inBitSet
    131                       /**< Input psBitSet */
    132                      );
     115psBitSet* psBitSetNot(
     116    psBitSet* outBitSet,               ///< Resulting psBitSet from operation
     117    const psBitSet* restrict inBitSet  ///< Input psBitSet
     118);
    133119
    134120/** Convert the psBitSet to a string of ones and zeros.
    … …  
    140126 */
    141127
    142 char *psBitSetToString(const psBitSet* restrict inMask
    143                        /**< psBitSet to convert */
    144                       );
     128char *psBitSetToString(
     129    const psBitSet* restrict inMask    ///< psBitSet to convert */
     130);
    145131
    146132/// @}

  • trunk/psLib/src/types/psBitSet.h

    r1441 r1472  
    1313 *  @author Ross Harman, MHPCC
    1414 *
    15  *  @version $Revision: 1.12 $ $Name: not supported by cvs2svn $
    16  *  @date $Date: 2004-08-09 23:40:55 $
     15 *  @version $Revision: 1.13 $ $Name: not supported by cvs2svn $
     16 *  @date $Date: 2004-08-11 19:53:33 $
    1717 *
    1818 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    3838typedef struct
    3939{
    40 
    41     int n;      /**< Number of bytes in the array */
    42 
    43     char *bits; /**< Aray of bytes holding bits */
     40    int n;                             ///< Number of bytes in the array
     41    char *bits;                        ///< Aray of bytes holding bits
    4442}
    4543psBitSet;
    … …  
    6058
    6159/*@null@*/
    62 
    63 psBitSet* psBitSetAlloc(int n
    64                         /**< Number of bits in psBitSet array */
    65                        );
     60psBitSet* psBitSetAlloc(
     61    int n                              ///< Number of bits in psBitSet array
     62);
    6663
    6764/** Set a bit.
    … …  
    7471 */
    7572psBitSet* psBitSetSet(
    76 
    77     /* @returned@ */ psBitSet* restrict inMask,
    78     /**< Pointer to psBitSet to be set. */
    79 
    80     int bit/**< Bit to be set. */
     73    /* @returned@ */
     74    psBitSet* restrict inMask,         ///< Pointer to psBitSet to be set.
     75    int bit                            ///< Bit to be set.
    8176);
    8277
    … …  
    9186 */
    9287
    93 bool psBitSetTest(const psBitSet* restrict inMask,
    94                   /**< Pointer psBitSet to be tested. */
    95 
    96                   int bit               /**< Bit to be tested. */
    97                  );
     88bool psBitSetTest(
     89    const psBitSet* restrict inMask,   ///< Pointer psBitSet to be tested.
     90    int bit                            ///< Bit to be tested.
     91);
    9892
    9993/** Perform a binary operation on two psBitSets
    … …  
    10599 */
    106100psBitSet* psBitSetOp(
    107 
    108     /* @returned@ */ psBitSet* restrict outMask,
    109     /**< Resulting psBitSet from binary operation */
    110 
    111     const psBitSet* restrict inMask1,
    112     /**< First psBitSet on which to operate */
    113 
    114     char *operator,         /**< Bit operation */
    115 
    116     const psBitSet* restrict inMask2
    117     /**< First psBitSet on which to operate */
     101    /* @returned@ */
     102    psBitSet* restrict outMask,        ///< Resulting psBitSet from binary operation
     103    const psBitSet* restrict inMask1,  ///< First psBitSet on which to operate
     104    char *operator,                    ///< Bit operation
     105    const psBitSet* restrict inMask2   ///< First psBitSet on which to operate
    118106);
    119107
    … …  
    125113 */
    126114
    127 psBitSet* psBitSetNot(psBitSet* outBitSet,
    128                       /**< Resulting psBitSet from operation */
    129 
    130                       const psBitSet* restrict inBitSet
    131                       /**< Input psBitSet */
    132                      );
     115psBitSet* psBitSetNot(
     116    psBitSet* outBitSet,               ///< Resulting psBitSet from operation
     117    const psBitSet* restrict inBitSet  ///< Input psBitSet
     118);
    133119
    134120/** Convert the psBitSet to a string of ones and zeros.
    … …  
    140126 */
    141127
    142 char *psBitSetToString(const psBitSet* restrict inMask
    143                        /**< psBitSet to convert */
    144                       );
     128char *psBitSetToString(
     129    const psBitSet* restrict inMask    ///< psBitSet to convert */
     130);
    145131
    146132/// @}
Note: See TracChangeset for help on using the changeset viewer.