IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Jun 8, 2005, 1:40:46 PM (21 years ago)
Author:
desonia
Message:

added comments on the end of #endif and #else

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

Legend:

Unmodified
Added
Removed

  • trunk/psLib/src/sysUtils/psAbort.h

    r3264 r4162  
    1212 *  @author Eric Van Alst, MHPCC
    1313 *
    14  *  @version $Revision: 1.9 $ $Name: not supported by cvs2svn $
    15  *  @date $Date: 2005-02-17 19:26:24 $
     14 *  @version $Revision: 1.10 $ $Name: not supported by cvs2svn $
     15 *  @date $Date: 2005-06-08 23:40:45 $
    1616 *
    1717 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    2929/** Reports an abort message to logging facility
    3030 *
    31  *  This function will invoke the psLogMsg function with a level of 
     31 *  This function will invoke the psLogMsg function with a level of
    3232 *  PS_LOG_ABORT and pass the parameters name and fmt to generate a proper
    33  *  log message.  After logging, this function will call system abort 
     33 *  log message.  After logging, this function will call system abort
    3434 *  function to abnormally terminate the program.
    3535 *
    … …  
    4343);
    4444
    45 /* @} */// Doxygen - End of SystemGroup Functions
     45/** @} */ // Doxygen - End of SystemGroup Functions
    4646
    47 #endif
     47#endif // #ifndef PS_ABORT_H

  • trunk/psLib/src/sysUtils/psConfigure.h

    r4137 r4162  
    1313 *  @author Robert DeSonia, MHPCC
    1414 *
    15  *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
    16  *  @date $Date: 2005-06-07 22:53:40 $
     15 *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     16 *  @date $Date: 2005-06-08 23:40:45 $
    1717 *
    1818 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    3838/** Initializes persistent memory.
    3939 *
    40  *  Creates persistant memory items used throughout psLib. Items created 
     40 *  Creates persistant memory items used throughout psLib. Items created
    4141 *  within this method should be freed with the psLibFinalize function.
    4242 *  current, a non-NULL psErr is returned with code PS_ERR_NONE.
    … …  
    6161
    6262
    63 /* @} */
     63/** @} */
    6464
    65 #endif
     65#endif // #ifndef PS_CONFIGURE_H

  • trunk/psLib/src/sysUtils/psError.h

    r3476 r4162  
    1212 *  @author Eric Van Alst, MHPCC
    1313 *
    14  *  @version $Revision: 1.20 $ $Name: not supported by cvs2svn $
    15  *  @date $Date: 2005-03-22 21:52:49 $
     14 *  @version $Revision: 1.21 $ $Name: not supported by cvs2svn $
     15 *  @date $Date: 2005-06-08 23:40:45 $
    1616 *
    1717 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    104104    va_list va                         ///< any parameters required in fmt
    105105);
    106 #endif
     106#endif // #ifndef SWIG
    107107
    108108#ifdef DOXYGEN
    … …  
    135135    ...
    136136);
    137 #else
     137#else // #ifdef DOXYGEN
    138138psErrorCode p_psError(
    139139    const char* file,
    … …  
    157157#define psError(code,new,...) p_psError(__FILE__,__LINE__,__func__,code,new,__VA_ARGS__)
    158158#define psWarning(...) p_psWarning(__FILE__,__LINE__,__func__,__VA_ARGS__)
    159 #endif
     159#endif // #ifndef SWIG
    160160
    161 #endif
     161#endif // ! DOXYGEN
    162162
    163163/** Create a new psErr struct

  • trunk/psLib/src/sysUtils/psErrorCodes.h

    r3264 r4162  
    77 *  @author Robert DeSonia, MHPCC
    88 *
    9  *  @version $Revision: 1.14 $ $Name: not supported by cvs2svn $
    10  *  @date $Date: 2005-02-17 19:26:24 $
     9 *  @version $Revision: 1.15 $ $Name: not supported by cvs2svn $
     10 *  @date $Date: 2005-06-08 23:40:45 $
    1111 *
    1212 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    2525 *     $2  The error description (rest of the line in psErrorCodes.dat)
    2626 *     $n  The order of the source line in psErrorCodes.dat (comments excluded)
    27  * 
     27 *
    2828 * DO NOT EDIT THE LINES BETWEEN //~Start and //~End!  ANY CHANGES WILL BE OVERWRITTEN.
    2929 */
    … …  
    7878/** Retrieves the description of an error code.
    7979 *
    80  *  The routine psErrorCodeString returns the string associated with an error 
     80 *  The routine psErrorCodeString returns the string associated with an error
    8181 *  code.
    8282 *
    … …  
    9090 *
    9191 *  Any project needed to use psLib must define the necessary error codes and
    92  *  associated message strings.  This function registers an array of error 
     92 *  associated message strings.  This function registers an array of error
    9393 *  codes with the error handling subsystem.
    9494 *
    … …  
    109109/// @}
    110110
    111 #endif
     111#endif // #ifndef PS_ERROR_CODES_H

  • trunk/psLib/src/sysUtils/psLogMsg.c

    r3476 r4162  
    1111 *  @author George Gusciora, MHPCC
    1212 *
    13  *  @version $Revision: 1.39 $ $Name: not supported by cvs2svn $
    14  *  @date $Date: 2005-03-22 21:52:49 $
     13 *  @version $Revision: 1.40 $ $Name: not supported by cvs2svn $
     14 *  @date $Date: 2005-06-08 23:40:45 $
    1515 *
    1616 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    227227}
    228228
    229 #if !defined(HOST_NAME_MAX)                // should be in limits.h
     229#ifndef HOST_NAME_MAX                // should be in limits.h
    230230#define HOST_NAME_MAX 256
    231 #endif
     231#endif // #ifndef HOST_NAME_MAX
    232232
    233233/*****************************************************************************

  • trunk/psLib/src/sysUtils/psLogMsg.h

    r3476 r4162  
    1111 *  @author George Gusciora, MHPCC
    1212 *
    13  *  @version $Revision: 1.22 $ $Name: not supported by cvs2svn $
    14  *  @date $Date: 2005-03-22 21:52:49 $
     13 *  @version $Revision: 1.23 $ $Name: not supported by cvs2svn $
     14 *  @date $Date: 2005-06-08 23:40:45 $
    1515 *
    1616 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1717 */
    18 #if !defined(PS_LOG_MSG_H)
     18#ifndef PS_LOG_MSG_H
    1919#define PS_LOG_MSG_H
    2020#include <stdarg.h>
    … …  
    8585    va_list ap                         ///< varargs argument list
    8686);
    87 #endif
     87#endif // #ifndef SWIG
    8888
    8989///< Status codes for log messages
    … …  
    104104/// @}
    105105
    106 #endif
     106#endif // #ifndef PS_LOG_MSG_H

  • trunk/psLib/src/sysUtils/psMemory.c

    r3784 r4162  
    88*  @author Robert Lupton, Princeton University
    99*
    10 *  @version $Revision: 1.51 $ $Name: not supported by cvs2svn $
    11 *  @date $Date: 2005-04-29 00:39:22 $
     10*  @version $Revision: 1.52 $ $Name: not supported by cvs2svn $
     11*  @date $Date: 2005-06-08 23:40:45 $
    1212*
    1313*  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    5050#ifdef PS_MEM_DEBUG
    5151static psMemBlock* deadBlockList;       // a place to put dead memBlocks in debug mode.
    52 #endif
     52#endif // #ifdef PS_MEM_DEBUG
    5353
    5454/**
    … …  
    626626            }
    627627            deadBlockList = ptr;
    628             #else
     628            #else // #ifdef PS_MEM_DEBUG
    629629
    630630            pthread_mutex_destroy(&ptr->refCounterMutex);
    631631            free(ptr);
    632             #endif
     632            #endif // #else - #ifdef PS_MEM_DEBUG
    633633
    634634        }

  • trunk/psLib/src/sysUtils/psMemory.h

    r3682 r4162  
    1212 *  @ingroup MemoryManagement
    1313 *
    14  *  @version $Revision: 1.36 $ $Name: not supported by cvs2svn $
    15  *  @date $Date: 2005-04-07 20:27:41 $
     14 *  @version $Revision: 1.37 $ $Name: not supported by cvs2svn $
     15 *  @date $Date: 2005-06-08 23:40:45 $
    1616 *
    1717 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1818 */
    1919
    20 #if !defined(PS_MEMORY_H)
     20#ifndef PS_MEMORY_H
    2121#define PS_MEMORY_H
    2222
    … …  
    125125 *
    126126 *  @return psPtr pointer to the allocated buffer. This will not be NULL.
    127  *  @see psFree 
     127 *  @see psFree
    128128 */
    129129#ifdef DOXYGEN
    130130psPtr psAlloc(size_t size       ///< Size required
    131131             );
    132 #else
     132#else // #ifdef DOXYGEN
    133133psPtr p_psAlloc(size_t size,    ///< Size required
    134134                const char *file,       ///< File of call
    … …  
    139139#ifndef SWIG
    140140#define psAlloc(size) p_psAlloc(size, __FILE__, __LINE__)
    141 #endif
    142 
    143 #endif
     141#endif // ! SWIG
     142
     143#endif // ! DOXYGEN
    144144
    145145/** Set the deallocator routine
    146146 *
    147  *  A deallocator routine can optionally be assigned to a memory block to 
     147 *  A deallocator routine can optionally be assigned to a memory block to
    148148 *  ensure that associated memory blocks also get freed, e.g., memory buffers
    149149 *  referenced within a struct.
    … …  
    157157/** Get the deallocator routine
    158158 *
    159  *  This function returns the deallocator for a memory block.  A deallocator 
    160  *  routine can optionally be assigned to a memory block to ensure that 
    161  *  associated memory blocks also get freed, e.g., memory buffers referenced 
    162  *  within a struct. 
     159 *  This function returns the deallocator for a memory block.  A deallocator
     160 *  routine can optionally be assigned to a memory block to ensure that
     161 *  associated memory blocks also get freed, e.g., memory buffers referenced
     162 *  within a struct.
    163163 *
    164164 *  @return psFreeFcn    the routine to be called at deallocation.
    … …  
    170170/** Set the memory as persistent so that it is ignored when detecting memory leaks.
    171171 *
    172  *  Used to mark a memory block as persistent data within the library, 
     172 *  Used to mark a memory block as persistent data within the library,
    173173 *  i.e., non user-level data used to hold psLib's state or cache data.  Such
    174174 *  examples of this class of memory is psTrace's trace-levels and dynamic
    … …  
    185185/** Get the memory's persistent flag.
    186186 *
    187  *  Checks if a memory block has been marked as persistent by 
     187 *  Checks if a memory block has been marked as persistent by
    188188 *  p_psMemSetPresistent.
    189189 *
    … …  
    207207    size_t size                         ///< Size required
    208208);
    209 #else
     209#else // #ifdef DOXYGEN
    210210psPtr p_psRealloc(
    211211    psPtr ptr,                         ///< Pointer to re-allocate
    … …  
    218218#ifndef SWIG
    219219#define psRealloc(ptr, size) p_psRealloc(ptr, size, __FILE__, __LINE__)
    220 #endif
    221 
    222 #endif
     220#endif // ! SWIG
     221
     222#endif // ! DOXYGEN
    223223
    224224/** Free memory.  This operates much like free().
    … …  
    230230    psPtr ptr                          ///< Pointer to free, if NULL, function returns immediately.
    231231);
    232 #else
     232#else // #ifdef DOXYGEN
    233233void p_psFree(
    234234    psPtr ptr,                         ///< Pointer to free
    … …  
    240240#ifndef SWIG
    241241#define psFree(ptr) p_psFree(ptr, __FILE__, __LINE__)
    242 #endif
    243 
    244 #endif
     242#endif // ! SWIG
     243
     244#endif // ! DOXYGEN
    245245
    246246/** Check for memory leaks.  This scans for allocated memory buffers not freed with an ID not less than id0.
    … …  
    299299#ifndef SWIG
    300300#define psMemIncrRefCounter(vptr) p_psMemIncrRefCounter(vptr, __FILE__, __LINE__)
    301 #endif
    302 
    303 #endif
     301#endif // !SWIG
     302
     303#endif // !DOXYGEN
    304304
    305305/** Decrement reference counter and return the pointer
    … …  
    307307 *  @ingroup memRefCount
    308308 *
    309  *  @return psPtr    the pointer deremented in refCount, or NULL if pointer is 
     309 *  @return psPtr    the pointer deremented in refCount, or NULL if pointer is
    310310 *                   fully dereferenced.
    311311 */
    … …  
    314314    psPtr vptr                         ///< Pointer to decrement refCounter, and return
    315315);
    316 #else
     316#else // DOXYGEN
    317317psPtr p_psMemDecrRefCounter(
    318318    psPtr vptr,                        ///< Pointer to decrement refCounter, and return
    … …  
    323323#ifndef SWIG
    324324#define psMemDecrRefCounter(vptr) p_psMemDecrRefCounter(vptr, __FILE__, __LINE__)
    325 #endif
    326 
    327 #endif
     325#endif // !SWIG
     326
     327#endif // !DOXYGEN
    328328
    329329/** Set callback for problems.
    330330 *
    331  *  At various occasions, the memory manager can check the state of the memory 
     331 *  At various occasions, the memory manager can check the state of the memory
    332332 *  stack. If any of these checks discover that the memory stack is corrupted,
    333333 *  the psMemProblemCallback is called.
    … …  
    343343/** Set callback for out-of-memory.
    344344 *
    345  *  If not enough memory is available to satisfy a request by psAlloc or 
    346  *  psRealloc, these functions attempt to find an alternative solution by 
    347  *  calling the psMemExhaustedCallback, a function which may be set by the 
    348  *  programmer in appropriate circumstances, rather than immediately fail. 
    349  *  The typical use of such a feature may be when a program needs a large 
    350  *  chunk of memory to do an operation, but the exact size is not critical. 
    351  *  This feature gives the programmer the opportunity to make a smaller 
     345 *  If not enough memory is available to satisfy a request by psAlloc or
     346 *  psRealloc, these functions attempt to find an alternative solution by
     347 *  calling the psMemExhaustedCallback, a function which may be set by the
     348 *  programmer in appropriate circumstances, rather than immediately fail.
     349 *  The typical use of such a feature may be when a program needs a large
     350 *  chunk of memory to do an operation, but the exact size is not critical.
     351 *  This feature gives the programmer the opportunity to make a smaller
    352352 *  request and try again, limiting the size of the operating buffer.
    353353 *
    … …  
    362362/** Set call back for when a particular memory block is allocated
    363363 *
    364  *  A private variable, p_psMemAllocateID, can be used to trace the allocation 
    365  *  and freeing of specific memory blocks. If p_psMemAllocateID is set and a 
    366  *  memory block with that ID is allocated, psMemAllocateCallback is called 
     364 *  A private variable, p_psMemAllocateID, can be used to trace the allocation
     365 *  and freeing of specific memory blocks. If p_psMemAllocateID is set and a
     366 *  memory block with that ID is allocated, psMemAllocateCallback is called
    367367 *  just before memory is returned to the calling function.
    368368 *
    … …  
    377377/** Set call back for when a particular memory block is freed
    378378 *
    379  *  A private variable, p_psMemFreeID, can be used to trace the freeing of 
    380  *  specific memory blocks. If p_psMemFreeID is set and the memory block with 
     379 *  A private variable, p_psMemFreeID, can be used to trace the freeing of
     380 *  specific memory blocks. If p_psMemFreeID is set and the memory block with
    381381 *  the ID is about to be freed, the psMemFreeCallback callback is called just
    382382 *  before the memory block is freed.
    … …  
    400400/** set p_psMemAllocateID to specific id
    401401 *
    402  *  A private variable, p_psMemAllocateID, can be used to trace the allocation 
    403  *  and freeing of specific memory blocks. If p_psMemAllocateID is set and a 
    404  *  memory block with that ID is allocated, psMemAllocateCallback is called 
     402 *  A private variable, p_psMemAllocateID, can be used to trace the allocation
     403 *  and freeing of specific memory blocks. If p_psMemAllocateID is set and a
     404 *  memory block with that ID is allocated, psMemAllocateCallback is called
    405405 *  just before memory is returned to the calling function.
    406406 *
    407407 *  @ingroup memCallback
    408408 *
    409  *  @return psMemoryId       
    410  *
    411  *  @see psMemAllocateCallbackSet   
     409 *  @return psMemoryId
     410 *
     411 *  @see psMemAllocateCallbackSet
    412412 */
    413413psMemoryId psMemAllocateCallbackSetID(
    … …  
    417417/** set p_psMemFreeID to id
    418418 *
    419  *  A private variable, p_psMemFreeID, can be used to trace the freeing of 
    420  *  specific memory blocks. If p_psMemFreeID is set and the memory block with 
     419 *  A private variable, p_psMemFreeID, can be used to trace the freeing of
     420 *  specific memory blocks. If p_psMemFreeID is set and the memory block with
    421421 *  the ID is about to be freed, the psMemFreeCallback callback is called just
    422422 *  before the memory block is freed.
    … …  
    442442#ifdef __GNUC__
    443443#pragma GCC poison malloc realloc calloc free
    444 #else
     444#else // __GNUC__
    445445#define malloc(S)       _Pragma("error Use of malloc is not allowed.  Use psAlloc instead.")
    446446#define realloc(P,S)    _Pragma("error Use of realloc is not allowed.  Use psRealloc instead.")
    447447#define calloc(S)       _Pragma("error Use of calloc is not allowed.  Use psAlloc instead.")
    448448#define free(P)         _Pragma("error Use of free is not allowed.  Use psFree instead.")
    449 #endif
    450 #endif
    451 
    452 #endif
    453 // doxygen skip
    454 
    455 #endif // end of header file
     449#endif // ! __GNUC__
     450#endif // #ifndef PS_ALLOW_MALLOC
     451
     452#endif // #ifndef DOXYGEN
     453
     454#endif // #ifndef PS_MEMORY_H

  • trunk/psLib/src/sysUtils/psString.h

    r3998 r4162  
    1313 *  @author Eric Van Alst, MHPCC
    1414 *
    15  *  @version $Revision: 1.12 $ $Name: not supported by cvs2svn $
    16  *  @date $Date: 2005-05-20 01:41:57 $
     15 *  @version $Revision: 1.13 $ $Name: not supported by cvs2svn $
     16 *  @date $Date: 2005-06-08 23:40:45 $
    1717 *
    1818 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    9999);
    100100
    101 /* @} */// Doxygen - End of SystemGroup Functions
     101/** @} */// Doxygen - End of SystemGroup Functions
    102102
    103 #endif
     103#endif // #ifndef PS_STRING_H

  • trunk/psLib/src/sysUtils/psSysUtilsErrors.h

    r3264 r4162  
    77 *  @author Robert DeSonia, MHPCC
    88 *
    9  *  @version $Revision: 1.15 $ $Name: not supported by cvs2svn $
    10  *  @date $Date: 2005-02-17 19:26:24 $
     9 *  @version $Revision: 1.16 $ $Name: not supported by cvs2svn $
     10 *  @date $Date: 2005-06-08 23:40:45 $
    1111 *
    1212 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    2323 *     $2  The error text (rest of the line in psSysUtilsErrors.dat)
    2424 *     $n  The order of the source line in psSysUtilsErrors.dat (comments excluded)
    25  * 
     25 *
    2626 * DO NOT EDIT THE LINES BETWEEN //~Start and //~End!  ANY CHANGES WILL BE OVERWRITTEN.
    2727 */
    … …  
    5050//~End
    5151
    52 #endif
     52#endif // #ifndef PS_SYSUTILS_ERRORS_H

  • trunk/psLib/src/sysUtils/psTrace.c

    r3850 r4162  
    99 *  @author GLG, MHPCC
    1010 *
    11  *  @version $Revision: 1.48 $ $Name: not supported by cvs2svn $
    12  *  @date $Date: 2005-05-05 21:24:50 $
     11 *  @version $Revision: 1.49 $ $Name: not supported by cvs2svn $
     12 *  @date $Date: 2005-06-08 23:40:45 $
    1313 *
    1414 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    555555}
    556556
    557 #endif
     557#endif // #ifndef PS_NO_TRACE

  • trunk/psLib/src/sysUtils/psType.h

    r3671 r4162  
    1010*  @author Ross Harman, MHPCC
    1111*
    12 *  @version $Revision: 1.32 $ $Name: not supported by cvs2svn $
    13 *  @date $Date: 2005-04-06 01:12:58 $
     12*  @version $Revision: 1.33 $ $Name: not supported by cvs2svn $
     13*  @date $Date: 2005-06-08 23:40:45 $
    1414*
    1515*  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    6262}
    6363psC64;
    64 #else
     64#else // SWIG
    6565typedef float _Complex psC32;          ///< complex with 32-bit floating point Real and Imagary numbers
    6666typedef double _Complex psC64;         ///< complex with 64-bit floating point Real and Imagary numbers
    67 #endif
     67#endif // !SWIG
    6868
    6969typedef void* psPtr;                   ///< void pointer
    … …  
    243243/// @}
    244244
    245 #endif
     245#endif // #ifndef PS_TYPE_H
Note: See TracChangeset for help on using the changeset viewer.