IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Aug 9, 2004, 12:44:25 PM (22 years ago)
Author:
desonia
Message:

fixed some stupid indent-induced formating problems and added doxygen
comments.

Location:
trunk/psLib/src/sysUtils
Files:
6 edited

Legend:

Unmodified
Added
Removed
  • trunk/psLib/src/sysUtils/psAbort.h

    r1407 r1426  
    1212 *  @author Eric Van Alst, MHPCC
    1313 *
    14  *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
    15  *  @date $Date: 2004-08-07 00:06:06 $
     14 *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     15 *  @date $Date: 2004-08-09 22:44:25 $
    1616 *
    1717 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
     
    3737 *
    3838 */
    39 void psAbort(const char *name,  // /< Source of abort such as file or function detected
    40              const char *fmt,   // /< A printf style formatting statement defining msg
     39void psAbort(const char *name,  ///< Source of abort such as file or function detected
     40             const char *fmt,   ///< A printf style formatting statement defining msg
    4141             ...
    4242            );
  • trunk/psLib/src/sysUtils/psError.h

    r1407 r1426  
    1313 *  @author Eric Van Alst, MHPCC
    1414 *
    15  *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
    16  *  @date $Date: 2004-08-07 00:06:06 $
     15 *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     16 *  @date $Date: 2004-08-09 22:44:25 $
    1717 *
    1818 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
     
    3535 *
    3636 */
    37 void psError(const char *name,  // /< Source of error such as file or function detected
    38              const char *fmt,   // /< A printf style formatting statement defining msg
     37void psError(const char *name,  ///< Source of error such as file or function detected
     38             const char *fmt,   ///< A printf style formatting statement defining msg
    3939             ...
    4040            );
  • trunk/psLib/src/sysUtils/psLogMsg.h

    r1407 r1426  
    1212 *  @author George Gusciora, MHPCC
    1313 *
    14  *  @version $Revision: 1.13 $ $Name: not supported by cvs2svn $
    15  *  @date $Date: 2004-08-07 00:06:06 $
     14 *  @version $Revision: 1.14 $ $Name: not supported by cvs2svn $
     15 *  @date $Date: 2004-08-09 22:44:25 $
    1616 *
    1717 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
     
    3030/// In future versions, this procedure will take a character string as an
    3131/// argument which can specify more general log destinations.
    32 int psLogSetDestination(const char *dest        // /< Specifies where to send messages.
     32int psLogSetDestination(const char *dest        ///< Specifies where to send messages.
    3333                       );
    3434
     
    3838/// Ie. higher values set by this procedure will cause more log messages to
    3939/// be displayed.
    40 int psLogSetLevel(int level     // /< Specifies the system log level
     40int psLogSetLevel(int level     ///< Specifies the system log level
    4141                 );
    4242
     
    4646/// Deleting a letter from the string will cause the associated information
    4747/// to not be logged.
    48 void psLogSetFormat(const char *fmt     // /< Specifies the system log format
     48void psLogSetFormat(const char *fmt     ///< Specifies the system log format
    4949                   );
    5050
     
    5353/// specified by a prior call to psLogSetLevel().  The message is specified
    5454/// with a printf-stype string an arguments.
    55 void psLogMsg(const char *name, // /< name of the log source
    56               int myLevel,      // /< severity level of this log message
    57               const char *fmt, ...      // /< printf-style format command
     55void psLogMsg(const char *name, ///< name of the log source
     56              int myLevel,      ///< severity level of this log message
     57              const char *fmt, ...      ///< printf-style format command
    5858             );
    5959
    6060/// This procedure is functionally equivalent to psLogMsg(), except that
    6161/// it takes a va_list as the message parameter, not a printf-style string.
    62 void psLogMsgV(const char *name,        // /< name of the log source
    63                int myLevel,     // /< severity level of this log message
    64                const char *fmt, // /< printf-style format command
    65                va_list ap       // /< varargs argument list
     62void psLogMsgV(const char *name,        ///< name of the log source
     63               int myLevel,     ///< severity level of this log message
     64               const char *fmt, ///< printf-style format command
     65               va_list ap       ///< varargs argument list
    6666              );
    6767
  • trunk/psLib/src/sysUtils/psMemory.h

    r1407 r1426  
    1515 *  @ingroup MemoryManagement
    1616 *
    17  *  @version $Revision: 1.24 $ $Name: not supported by cvs2svn $
    18  *  @date $Date: 2004-08-07 00:06:06 $
     17 *  @version $Revision: 1.25 $ $Name: not supported by cvs2svn $
     18 *  @date $Date: 2004-08-09 22:44:25 $
    1919 *
    2020 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
     
    6363typedef struct psMemBlock
    6464{
    65     const void *startblock;     // /< initialised to p_psMEMMAGIC
    66     struct psMemBlock *previousBlock;   // /< previous block in allocation list
    67     struct psMemBlock *nextBlock;       // /< next block allocation list
    68     psFreeFcn freeFcn;          // /< deallocator.  If NULL, use generic deallocation.
    69     size_t userMemorySize;      // /< the size of the user-portion of the memory block
    70     const psMemoryId id;        // /< a unique ID for this allocation
    71     const char *file;           // /< set from __FILE__ in e.g. p_psAlloc
    72     const int lineno;           // /< set from __LINE__ in e.g. p_psAlloc
    73     pthread_mutex_t refCounterMutex;    // /< mutex to ensure exclusive access to reference counter
    74     psReferenceCount refCounter;        // /< how many times pointer is referenced
    75     const void *endblock;       // /< initialised to p_psMEMMAGIC
     65    const void *startblock;     ///< initialised to p_psMEMMAGIC
     66    struct psMemBlock *previousBlock;   ///< previous block in allocation list
     67    struct psMemBlock *nextBlock;       ///< next block allocation list
     68    psFreeFcn freeFcn;          ///< deallocator.  If NULL, use generic deallocation.
     69    size_t userMemorySize;      ///< the size of the user-portion of the memory block
     70    const psMemoryId id;        ///< a unique ID for this allocation
     71    const char *file;           ///< set from __FILE__ in e.g. p_psAlloc
     72    const int lineno;           ///< set from __LINE__ in e.g. p_psAlloc
     73    pthread_mutex_t refCounterMutex;    ///< mutex to ensure exclusive access to reference counter
     74    psReferenceCount refCounter;        ///< how many times pointer is referenced
     75    const void *endblock;       ///< initialised to p_psMEMMAGIC
    7676}
    7777psMemBlock;
     
    8282 *  @ingroup memCallback
    8383 */
    84 typedef psMemoryId(*psMemAllocateCallback) (const psMemBlock * ptr      // /< the psMemBlock just allocated
     84typedef psMemoryId(*psMemAllocateCallback) (const psMemBlock * ptr      ///< the psMemBlock just allocated
    8585                                           );
    8686
     
    9090 *  @ingroup memCallback
    9191 */
    92 typedef psMemoryId(*psMemFreeCallback) (const psMemBlock * ptr  // /< the psMemBlock being freed
     92typedef psMemoryId(*psMemFreeCallback) (const psMemBlock * ptr  ///< the psMemBlock being freed
    9393                                       );
    9494
     
    100100 *  @ingroup memCallback
    101101 */
    102 typedef void (*psMemProblemCallback) (const psMemBlock * ptr,   // /< the pointer to the problematic memory
     102typedef void (*psMemProblemCallback) (const psMemBlock * ptr,   ///< the pointer to the problematic memory
    103103                                      // block.
    104                                       const char *file, // /< the file in which the problem originated
    105                                       int lineno        // /< the line number in which the problem originated
     104                                      const char *file, ///< the file in which the problem originated
     105                                      int lineno        ///< the line number in which the problem originated
    106106                                     );
    107107
     
    123123 */
    124124#    ifdef DOXYGEN
    125 void *psAlloc(size_t size       // /< Size required
     125void *psAlloc(size_t size       ///< Size required
    126126             );
    127127#    else
    128     void *p_psAlloc(size_t size,    // /< Size required
    129                     const char *file,       // /< File of call
    130                     int lineno      // /< Line number of call
     128
     129    void *p_psAlloc(size_t size,    ///< Size required
     130                    const char *file,       ///< File of call
     131                    int lineno      ///< Line number of call
    131132                   );
    132133
     
    144145 */
    145146#    ifdef DOXYGEN
    146 void *psRealloc(void *ptr       // /< Pointer to re-allocate
    147                 size_t size,    // /< Size required
     147void *psRealloc(void *ptr       ///< Pointer to re-allocate
     148                size_t size,    ///< Size required
    148149               );
    149150#    else
    150     void *p_psRealloc(void *ptr,    // /< Pointer to re-allocate
    151                       size_t size,  // /< Size required
    152                       const char *file,     // /< File of call
    153                       int lineno    // /< Line number of call
     151
     152    void *p_psRealloc(void *ptr,    ///< Pointer to re-allocate
     153                      size_t size,  ///< Size required
     154                      const char *file,     ///< File of call
     155                      int lineno    ///< Line number of call
    154156                     );
    155157
     
    164166 */
    165167#    ifdef DOXYGEN
    166 void psFree(void *ptr,          // /< Pointer to free, if NULL, function returns immediately.
     168void psFree(void *ptr,          ///< Pointer to free, if NULL, function returns immediately.
    167169           );
    168170#    else
    169     void p_psFree(void *ptr,        // /< Pointer to free
    170                   const char *file, // /< File of call
    171                   int lineno        // /< Line number of call
     171
     172    void p_psFree(void *ptr,        ///< Pointer to free
     173                  const char *file, ///< File of call
     174                  int lineno        ///< Line number of call
    172175                 );
    173176
     
    191194 *  @ingroup memTracing
    192195 */
    193 int psMemCheckLeaks(psMemoryId id0,     // /< don't list blocks with id < id0
    194                     psMemBlock *** arr, // /< pointer to array of pointers to leaked blocks, or NULL
    195                     FILE * fd   // /< print list of leaks to fd (or NULL)
     196int psMemCheckLeaks(psMemoryId id0,     ///< don't list blocks with id < id0
     197                    psMemBlock *** arr, ///< pointer to array of pointers to leaked blocks, or NULL
     198                    FILE * fd   ///< print list of leaks to fd (or NULL)
    196199                   );
    197200
     
    201204 *  @ingroup memTracing
    202205 */
    203 int psMemCheckCorruption(bool abort_on_error    // /< Abort on detecting corruption?
     206int psMemCheckCorruption(bool abort_on_error    ///< Abort on detecting corruption?
    204207                        );
    205208
     
    208211 *  @ingroup memRefCount
    209212 */
    210 psReferenceCount psMemGetRefCounter(void *vptr  // /< Pointer to get refCounter for
     213psReferenceCount psMemGetRefCounter(void *vptr  ///< Pointer to get refCounter for
    211214                                   );
    212215
     
    216219 */
    217220#    ifdef DOXYGEN
    218 void *psMemIncrRefCounter(void *vptr    // /< Pointer to increment refCounter, and return
     221void *psMemIncrRefCounter(void *vptr    ///< Pointer to increment refCounter, and return
    219222                         );
    220223#    else
    221     void *p_psMemIncrRefCounter(void *vptr, // /< Pointer to increment refCounter, and return
    222                                 const char *file,   // /< File of call
    223                                 int lineno  // /< Line number of call
     224
     225    void *p_psMemIncrRefCounter(void *vptr, ///< Pointer to increment refCounter, and return
     226                                const char *file,   ///< File of call
     227                                int lineno  ///< Line number of call
    224228                               );
    225229
     
    232236 */
    233237#    ifdef DOXYGEN
    234 void *psMemDecrRefCounter(void *vptr    // /< Pointer to decrement refCounter, and return
     238void *psMemDecrRefCounter(void *vptr    ///< Pointer to decrement refCounter, and return
    235239                         );
    236240#    else
    237     void *p_psMemDecrRefCounter(void *vptr, // /< Pointer to decrement refCounter, and return
    238                                 const char *file,   // /< File of call
    239                                 int lineno  // /< Line number of call
     241
     242    void *p_psMemDecrRefCounter(void *vptr, ///< Pointer to decrement refCounter, and return
     243                                const char *file,   ///< File of call
     244                                int lineno  ///< Line number of call
    240245                               );
    241246
     
    246251 *  @ingroup memCallback
    247252 */
    248 psMemProblemCallback psMemProblemCallbackSet(psMemProblemCallback func  // /< Function to run
     253psMemProblemCallback psMemProblemCallbackSet(psMemProblemCallback func  ///< Function to run
    249254                                            );
    250255
     
    253258 *  @ingroup memCallback
    254259 */
    255 psMemExhaustedCallback psMemExhaustedCallbackSet(psMemExhaustedCallback func    // /< Function to run
     260psMemExhaustedCallback psMemExhaustedCallbackSet(psMemExhaustedCallback func    ///< Function to run
    256261                                                );
    257262
     
    260265 *  @ingroup memCallback
    261266 */
    262 psMemAllocateCallback psMemAllocateCallbackSet(psMemAllocateCallback func       // /< Function to run
     267psMemAllocateCallback psMemAllocateCallbackSet(psMemAllocateCallback func       ///< Function to run
    263268                                              );
    264269
     
    267272 *  @ingroup memCallback
    268273 */
    269 psMemFreeCallback psMemFreeCallbackSet(psMemFreeCallback func   // /< Function to run
     274psMemFreeCallback psMemFreeCallbackSet(psMemFreeCallback func   ///< Function to run
    270275                                      );
    271276
     
    280285 *  @ingroup memCallback
    281286 */
    282 psMemoryId psMemAllocateCallbackSetID(psMemoryId id     // /< ID to set
     287psMemoryId psMemAllocateCallbackSetID(psMemoryId id     ///< ID to set
    283288                                     );
    284289
     
    287292 *  @ingroup memCallback
    288293 */
    289 psMemoryId psMemFreeCallbackSetID(psMemoryId id // /< ID to set
     294psMemoryId psMemFreeCallbackSetID(psMemoryId id ///< ID to set
    290295                                 );
    291296
  • trunk/psLib/src/sysUtils/psTrace.h

    r1407 r1426  
    1010 *  @author George Gusciora, MHPCC
    1111 *
    12  *  @version $Revision: 1.12 $ $Name: not supported by cvs2svn $
    13  *  @date $Date: 2004-08-07 00:06:06 $
     12 *  @version $Revision: 1.13 $ $Name: not supported by cvs2svn $
     13 *  @date $Date: 2004-08-09 22:44:25 $
    1414 *
    1515 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
     
    5959#        ifndef DOXYGEN
    6060/// Send a trace message
    61 void p_psTrace(const char *facil,       // /< facilty of interest
    62                int myLevel,     // /< desired trace level
    63                ...)             // /< trace message arguments
     61void p_psTrace(const char *facil,       ///< facilty of interest
     62               int myLevel,     ///< desired trace level
     63               ...)             ///< trace message arguments
    6464;
    6565#        endif
    6666
    6767/// Set trace level
    68 int psTraceSetLevel(const char *facil,     // /< facilty of interest
    69                     int level)     // /< desired trace level
     68int psTraceSetLevel(const char *facil,     ///< facilty of interest
     69                    int level)     ///< desired trace level
    7070;
    7171
    7272/// Get the trace level
    73 int psTraceGetLevel(const char *facil)     // /< facilty of interest
     73int psTraceGetLevel(const char *facil)     ///< facilty of interest
    7474;
    7575
  • trunk/psLib/src/sysUtils/psType.h

    r1407 r1426  
    1111*  @author Ross Harman, MHPCC
    1212*
    13 *  @version $Revision: 1.17 $ $Name: not supported by cvs2svn $
    14 *  @date $Date: 2004-08-07 00:06:06 $
     13*  @version $Revision: 1.18 $ $Name: not supported by cvs2svn $
     14*  @date $Date: 2004-08-09 22:44:25 $
    1515*
    1616*  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
     
    4040 */
    4141
    42 typedef uint8_t psU8;           // /< 8-bit unsigned int
    43 typedef uint16_t psU16;         // /< 16-bit unsigned int
    44 typedef uint32_t psU32;         // /< 32-bit unsigned int
    45 typedef uint64_t psU64;         // /< 64-bit unsigned int
    46 typedef int8_t psS8;            // /< 8-bit signed int
    47 typedef int16_t psS16;          // /< 16-bit signed int
    48 typedef int32_t psS32;          // /< 32-bit signed int
    49 typedef int64_t psS64;          // /< 64-bit signed int
    50 typedef float psF32;            // /< 32-bit floating point
    51 typedef double psF64;           // /< 64-bit floating point
    52 typedef complex float psC32;    // /< complex with 32-bit floating point Real and Imagary numbers
    53 typedef complex double psC64;   // /< complex with 64-bit floating point Real and Imagary numbers
    54 typedef void *psPTR;            // /< void pointer
     42typedef uint8_t psU8;           ///< 8-bit unsigned int
     43typedef uint16_t psU16;         ///< 16-bit unsigned int
     44typedef uint32_t psU32;         ///< 32-bit unsigned int
     45typedef uint64_t psU64;         ///< 64-bit unsigned int
     46typedef int8_t psS8;            ///< 8-bit signed int
     47typedef int16_t psS16;          ///< 16-bit signed int
     48typedef int32_t psS32;          ///< 32-bit signed int
     49typedef int64_t psS64;          ///< 64-bit signed int
     50typedef float psF32;            ///< 32-bit floating point
     51typedef double psF64;           ///< 64-bit floating point
     52typedef complex float psC32;    ///< complex with 32-bit floating point Real and Imagary numbers
     53typedef complex double psC64;   ///< complex with 64-bit floating point Real and Imagary numbers
     54typedef void *psPTR;            ///< void pointer
    5555
    5656typedef enum {
    57     PS_TYPE_S8 = 0x0101,        // /< Character.
    58     PS_TYPE_S16 = 0x0102,                  // /< Short integer.
    59     PS_TYPE_S32 = 0x0104,                  // /< Integer.
    60     PS_TYPE_S64 = 0x0108,                  // /< Long integer.
    61     PS_TYPE_U8 = 0x0301,                   // /< Unsigned character.
    62     PS_TYPE_U16 = 0x0302,                  // /< Unsigned short integer.
    63     PS_TYPE_U32 = 0x0304,                  // /< Unsigned integer.
    64     PS_TYPE_U64 = 0x0308,                  // /< Unsigned long integer.
    65     PS_TYPE_F32 = 0x0404,                  // /< Single-precision Floating point.
    66     PS_TYPE_F64 = 0x0408,                  // /< Double-precision floating point.
    67     PS_TYPE_C32 = 0x0808,                  // /< Complex numbers consisting of single-precision floating
     57    PS_TYPE_S8 = 0x0101,        ///< Character.
     58    PS_TYPE_S16 = 0x0102,                  ///< Short integer.
     59    PS_TYPE_S32 = 0x0104,                  ///< Integer.
     60    PS_TYPE_S64 = 0x0108,                  ///< Long integer.
     61    PS_TYPE_U8 = 0x0301,                   ///< Unsigned character.
     62    PS_TYPE_U16 = 0x0302,                  ///< Unsigned short integer.
     63    PS_TYPE_U32 = 0x0304,                  ///< Unsigned integer.
     64    PS_TYPE_U64 = 0x0308,                  ///< Unsigned long integer.
     65    PS_TYPE_F32 = 0x0404,                  ///< Single-precision Floating point.
     66    PS_TYPE_F64 = 0x0408,                  ///< Double-precision floating point.
     67    PS_TYPE_C32 = 0x0808,                  ///< Complex numbers consisting of single-precision floating
    6868    // point.
    69     PS_TYPE_C64 = 0x0810,                  // /< Complex numbers consisting of double-precision floating
     69    PS_TYPE_C64 = 0x0810,                  ///< Complex numbers consisting of double-precision floating
    7070    // point.
    71     PS_TYPE_PTR = 0x0000                   // /< Something else that's not supported for arithmetic.
     71    PS_TYPE_PTR = 0x0000                   ///< Something else that's not supported for arithmetic.
    7272} psElemType;
    7373
    74 #    define PS_TYPE_MASK PS_TYPE_U8        // /< the psElemType to use for mask image
    75 #    define PS_TYPE_MASK_DATA U8           // /< the data member to use for mask image
     74#    define PS_TYPE_MASK PS_TYPE_U8        ///< the psElemType to use for mask image
     75#    define PS_TYPE_MASK_DATA U8           ///< the data member to use for mask image
    7676#    define PS_TYPE_MASK_NAME "psU8"
    77 typedef psU8 psMaskType;        // /< the C datatype for a mask image
     77typedef psU8 psMaskType;        ///< the C datatype for a mask image
    7878
    7979#    define PS_MIN_S8        INT8_MIN
     
    132132 */
    133133typedef enum {
    134     PS_DIMEN_SCALAR,            // /< Scalar.
    135     PS_DIMEN_VECTOR,            // /< Vector.
    136     PS_DIMEN_TRANSV,            // /< Transposed vector.
    137     PS_DIMEN_IMAGE,             // /< Image.
    138     PS_DIMEN_OTHER              // /< Something else that's not supported for arithmetic.
     134    PS_DIMEN_SCALAR,            ///< Scalar.
     135    PS_DIMEN_VECTOR,            ///< Vector.
     136    PS_DIMEN_TRANSV,            ///< Transposed vector.
     137    PS_DIMEN_IMAGE,             ///< Image.
     138    PS_DIMEN_OTHER              ///< Something else that's not supported for arithmetic.
    139139} psDimen;
    140140
     
    147147typedef struct
    148148{
    149     psElemType type;            // /< Primitive type.
    150     psDimen dimen;              // /< Dimensionality.
     149    psElemType type;            ///< Primitive type.
     150    psDimen dimen;              ///< Dimensionality.
    151151}
    152152psType;
Note: See TracChangeset for help on using the changeset viewer.