IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Changeset 11248 for trunk/psLib/src/sys


Ignore:
Timestamp:
Jan 23, 2007, 12:47:23 PM (20 years ago)
Author:
magnier
Message:

major cleanup of the Doxygen groups

Location:
trunk/psLib/src/sys
Files:
13 edited

Legend:

Unmodified
Added
Removed

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

    r8627 r11248  
    1 
    21/** @file  psAbort.h
    32 *
    … …  
    87 *  needing to abort from program execution.
    98 *
    10  *  @ingroup ErrorHandling
    11  *
    129 *  @author Eric Van Alst, MHPCC
    1310 *
    14  *  @version $Revision: 1.12 $ $Name: not supported by cvs2svn $
    15  *  @date $Date: 2006-08-26 04:34:28 $
    16  *
     11 *  $Revision: 1.13 $ $Name: not supported by cvs2svn $
     12 *  $Date: 2007-01-23 22:47:23 $
    1713 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1814 */
    … …  
    2117#define PS_ABORT_H
    2218
    23 // Doxygen grouping tags
    24 
    25 /** @addtogroup ErrorHandling
    26  *  @{
    27  */
     19/// @addtogroup SysUtils System Utilities
     20/// @{
    2821
    2922/** Reports an abort message to logging facility
    … …  
    5144#endif // __GNUC__
    5245
    53 /** @} */ // Doxygen - End of SystemGroup Functions
    54 
     46/// @}
    5547#endif // #ifndef PS_ABORT_H

  • trunk/psLib/src/sys/psAssert.h

    r9597 r11248  
    11#ifndef PS_ASSERT_H
    22#define PS_ASSERT_H
     3
     4/// @addtogroup SysUtils System Utilities
     5/// @{
    36
    47#include <assert.h>
    … …  
    263266
    264267
     268/// @}
    265269#endif

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

    r10286 r11248  
    11/** @file  psConfigure.h
    22 *
    3  *  @brief Contains the declarations for initialization, memory finalization,
    4  *   and configuration.
     3 *  @brief Functions to init and cleanup psLib
    54 *
    65 *  These functions initalize psLib data before the beginning of a run and
    … …  
    87 *  also provided to return the current psLib version.
    98 *
    10  *  @ingroup Configure
    119 *
    1210 *  @author Ross Harman, MHPCC
    1311 *  @author Robert DeSonia, MHPCC
    1412 *
    15  *  @version $Revision: 1.9 $ $Name: not supported by cvs2svn $
    16  *  @date $Date: 2006-11-29 21:33:09 $
     13 *  @version $Revision: 1.10 $ $Name: not supported by cvs2svn $
     14 *  @date $Date: 2007-01-23 22:47:23 $
    1715 *
    1816 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    2220#define PS_CONFIGURE_H
    2321
    24 /** @addtogroup Configure
    25  *  @{
    26  */
     22/// @addtogroup SysUtils System Utilities
     23/// @{
    2724
    2825/** Get current psLib version
    … …  
    7067void p_psMemoryCheck(void);
    7168
    72 /** @} */
    73 
     69/// @}
    7470#endif // #ifndef PS_CONFIGURE_H

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

    r8802 r11248  
    11/** @file  psError.h
    22 *
    3  *  @brief Contains the declarations for the error reporting functions
     3 *  @brief error reporting functions
    44 *
    55 *  Error reporting functions shall be used to create log entries in the
    … …  
    88 *  of error detected.
    99 *
    10  *  @ingroup ErrorHandling
    11  *
     10 *  @author RHL, Princeton
    1211 *  @author Eric Van Alst, MHPCC
    1312 *
    14  *  @version $Revision: 1.31 $ $Name: not supported by cvs2svn $
    15  *  @date $Date: 2006-09-12 21:39:47 $
     13 *  @version $Revision: 1.32 $ $Name: not supported by cvs2svn $
     14 *  @date $Date: 2007-01-23 22:47:23 $
    1615 *
    1716 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    2019#ifndef PS_ERROR_H
    2120#define PS_ERROR_H
     21
     22/// @addtogroup SysUtils System Utilities
     23/// @{
    2224
    2325#include<stdio.h>
    … …  
    2830
    2931#define _(string) string
    30 
    31 /** @addtogroup ErrorHandling
    32  *  @{
    33  */
    3432
    3533/** Error message object */
    … …  
    231229);
    232230
    233 /* @} */// End of SysUtils Functions
    234 
     231/// @}
    235232#endif

  • trunk/psLib/src/sys/psErrorCodes.h.in

    r7957 r11248  
    33 *  @brief Contains the error codes for the error classes
    44 *
    5  *  @ingroup ErrorHandling
    6  *
     5 *  @author RHL, Princeton
    76 *  @author Robert DeSonia, MHPCC
    87 *
    9  *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
    10  *  @date $Date: 2006-07-25 00:30:31 $
     8 *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
     9 *  @date $Date: 2007-01-23 22:47:23 $
    1110 *
    1211 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    1615#define PS_ERROR_CODES_H
    1716
     17/// @addtogroup SysUtils System Utilities
     18/// @{
     19
    1820#include "psType.h"
    19 
    20 /** @addtogroup ErrorHandling
    21  *  @{
    22  */
    2321
    2422/** enumeration of the static error code classes
    … …  
    8482
    8583/// @}
    86 
    8784#endif // #ifndef PS_ERROR_CODES_H

  • trunk/psLib/src/sys/psExit.h

    r10979 r11248  
    11#ifndef PS_EXIT_H
    22#define PS_EXIT_H
     3
     4/// @addtogroup SysUtils System Utilities
     5/// @{
    36
    47/// Exit status codes
    … …  
    1518} psExit;
    1619
     20/// @}
    1721#endif

  • trunk/psLib/src/sys/psLine.h

    r7950 r11248  
    11/** @file  psLine.h
    22 *
    3  *
    4  *  @brief Contains the declarations of line utility functions
    5  *
    6  *  @ingroup SysUtils
     3 *  @brief charater-string fixed-length line functions
    74 *
    85 *  The psLine functions allow manipulation of fixed-length lines.
    96 *
     7 *  @author EAM, IFA
    108 *  @author Paul Price, IFA
    119 *  @author David Robbins, MHPCC
    1210 *
    13  *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
    14  *  @date $Date: 2006-07-21 02:39:33 $
     11 *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     12 *  @date $Date: 2007-01-23 22:47:23 $
    1513 *
    1614 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    … …  
    2018#define PS_LINE_H
    2119
     20/// @addtogroup SysUtils System Utilities
     21/// @{
     22
    2223#include "psString.h"
    23 
    24 /** @addtogroup SysUtils
    25  *  @{
    26  */
    2724
    2825/** Structure to carry a dynamic string */
    … …  
    7774);
    7875
     76/// @}
    7977#endif /* PS_LINE_H */

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

    r10429 r11248  
    11/** @file  psLogMsg.h
     2 *
    23 *  @brief Procedures for logging messages.
    3  *  \ingroup LogTrace
    44 *
    55 *  This file will hold the prototypes for defining procedure which set
    66 *  message log levels, messahe log formats, message log destinations, and
    77 *  for generating the messages themselves.
    8  *  @ingroup LogTrace
    98 *
    109 *  @author Robert Lupton, Princeton University
    1110 *  @author GLG, MHPCC
    1211 *
    13  *  @version $Revision: 1.37 $ $Name: not supported by cvs2svn $
    14  *  @date $Date: 2006-12-04 20:45:46 $
     12 *  @version $Revision: 1.38 $ $Name: not supported by cvs2svn $
     13 *  @date $Date: 2007-01-23 22:47:23 $
    1514 *
    1615 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1716 */
     17
    1818#ifndef PS_LOG_MSG_H
    1919#define PS_LOG_MSG_H
     20
     21/// @addtogroup SysUtils System Utilities
     22/// @{
     23
    2024#include <stdarg.h>
    21 
    2225#include "psType.h"
    23 
    24 /** @addtogroup LogTrace
    25  *  @{
    26  */
    2726
    2827/** This procedure sets the destination for future log messages.
    … …  
    137136
    138137/// @}
    139 
    140138#endif // #ifndef PS_LOG_MSG_H

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

    r9538 r11248  
    1 /** @file  psMemory.h
    2  *
    3  *  @brief Contains the definitions for the memory management system
    4  *
    5  *  This is the generic memory management system put inbetween the user's high level code and the OS-level
    6  *  memory allocation routines.  This system adds such features as callback routines for memory error events,
    7  *  tracing capabilities, and reference counting.
    8  *
    9  *  @author Robert DeSonia, MHPCC
    10  *  @author Robert Lupton, Princeton University
    11  *
    12  *  @ingroup MemoryManagement
    13  *
    14  *  @version $Revision: 1.61 $ $Name: not supported by cvs2svn $
    15  *  @date $Date: 2006-10-13 21:13:48 $
    16  *
    17  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     1/* @file  psMemory.h
     2 *
     3 * @brief Contains the definitions for the memory management system
     4 *
     5 * This is the generic memory management system put inbetween the user's high level code and the OS-level
     6 * memory allocation routines.  This system adds such features as callback routines for memory error events,
     7 * tracing capabilities, and reference counting.
     8 *
     9 * @author Robert Lupton, Princeton University
     10 * @author Robert DeSonia, MHPCC
     11 *
     12 * $Revision: 1.62 $ $Name: not supported by cvs2svn $
     13 * $Date: 2007-01-23 22:47:23 $
     14 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1815 */
    1916
    … …  
    2118#define PS_MEMORY_H
    2219
     20/// @addtogroup SysUtils System Utilities
     21/// @{
     22
    2323#include <stdio.h>                     // needed for FILE
    2424#include <pthread.h>                   // we need a mutex to make this stuff thread safe.
    25 
    2625#include "psType.h"
    2726
    28 /** @addtogroup MemoryManagement
    29  *  @{
    30  */
    31 
    3227#define P_PS_MEMMAGIC (psPtr)0xdeadbeef   // Magic number in psMemBlock header
    33 
    34 /**
    35  *  @addtogroup memCallback Memory Callbacks
    36  *
    37  *  Routines dealing with the creating and setting of memory management callback functions.
    38  */
    39 
    40 /**
    41  *  @addtogroup memTracing Memory Tracing
    42  *
    43  *  Routines dealing with memory tracing and corruption checking.
    44  */
    45 
    46 /**
    47  *  @addtogroup memRefCount Reference Count
    48  *
    49  *  Routines dealing with the reference counting of allocated buffers.
    50  */
    5128
    5229/// typedef for memory identification numbers.  Guaranteed to be some variety of integer.
    … …  
    8461 *
    8562 *  @see psMemAllocCallbackSet
    86  *  @ingroup memCallback
    8763 */
    8864typedef psMemId(*psMemAllocCallback) (
    … …  
    9369 *
    9470 *  @see psMemFreeCallbackSet
    95  *  @ingroup memCallback
    9671 */
    9772typedef psMemId(*psMemFreeCallback) (
    … …  
    10479 *
    10580 *  @see psMemProblemCallbackSet
    106  *  @ingroup memCallback
    10781 */
    10882typedef void (*psMemProblemCallback) (
    … …  
    11892 *
    11993 *  @see psMemExhaustedCallbackSet
    120  *  @ingroup memCallback
    12194 */
    12295typedef psPtr (*psMemExhaustedCallback) (
    … …  
    303276 *              blocks above id0 that have not been freed.
    304277 *  @see psAlloc, psFree, psgetMemId, psMemProblemCallbackSet
    305  *  @ingroup memTracing
    306278 */
    307279int psMemCheckLeaks(
    … …  
    317289 *  @return int
    318290 *
    319  *  @ingroup memTracing
    320291 */
    321292int psMemCheckCorruption(
    … …  
    327298 *  @return psReferenceCount
    328299 *
    329  *  @ingroup memRefCount
    330300 */
    331301psReferenceCount psMemGetRefCounter(
    … …  
    337307 *  @return psPtr
    338308 *
    339  *  @ingroup memRefCount
    340309 */
    341310#ifdef DOXYGEN
    … …  
    358327/** Decrement reference counter and return the pointer
    359328 *
    360  *  @ingroup memRefCount
    361329 *
    362330 *  @return psPtr    the pointer deremented in refCount, or NULL if pointer is
    … …  
    381349
    382350/** Set reference counter and return the pointer
    383  *
    384  *  @ingroup memRefCount
    385351 *
    386352 *  @return psPtr    the pointer with refCount set, or NULL if pointer is
    … …  
    411377 *  stack. If any of these checks discover that the memory stack is corrupted,
    412378 *  the psMemProblemCallback is called.
    413  
    414  *  @ingroup memCallback
    415379 *
    416380 *  @return psMemProblemCallback       old psMemProblemCallback function
    … …  
    431395 *  request and try again, limiting the size of the operating buffer.
    432396 *
    433  *  @ingroup memCallback
    434  *
    435397 *  @return psMemExhaustedCallback     old psMemExhaustedCallback function
    436398 */
    … …  
    446408 *  just before memory is returned to the calling function.
    447409 *
    448  *  @ingroup memCallback
    449  *
    450410 *  @return psMemAllocCallback      old psMemAllocCallback function
    451411 */
    … …  
    461421 *  before the memory block is freed.
    462422 *
    463  *  @ingroup memCallback
    464  *
    465423 *  @return psMemFreeCallback          old psMemFreeCallback function
    466424 */
    … …  
    471429/** get next memory ID
    472430 *
    473  *  @ingroup memCallback
    474  *
    475431 *  @return psMemId                 the next memory ID to be used
    476432 */
    … …  
    478434
    479435/** get the last memory ID used
    480  *
    481  *  @ingroup memCallback
    482436 *
    483437 *  @return psMemId                 the last memory ID used
    … …  
    492446 *  just before memory is returned to the calling function.
    493447 *
    494  *  @ingroup memCallback
    495  *
    496448 *  @return psMemId
    497449 *
    … …  
    509461 *  before the memory block is freed.
    510462 *
    511  *  @ingroup memCallback
    512  *
    513463 *  @return psMemId                 the old p_psMemFreeID
    514464 *
    … …  
    530480                  size_t *freelist); ///< memory that's waiting to be recycled
    531481
    532 //@} End of Memory Management Functions
     482/// @} end of SysUtils
    533483
    534484#ifndef DOXYGEN
    … …  
    549499
    550500#endif // #ifndef DOXYGEN
    551 
    552501#endif // #ifndef PS_MEMORY_H

  • trunk/psLib/src/sys/psSlurp.h

    r11154 r11248  
     1/* @file  psSlurp.h
     2 * @brief read complete files into strings
     3 *
     4 * @author JH
     5 * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     6 * @date $Date: 2007-01-23 22:47:23 $
     7 */
     8
    19#ifndef PS_SLURP_H
    210#define PS_SLURP_H
     11
     12/// @addtogroup FileIO Input/Output
     13/// @{
    314
    415// Read ("slurp") a file (specified by file descriptor)
    … …  
    1223                    );
    1324
    14 
     25/// @}
    1526#endif

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

    r10949 r11248  
    1 /** @file  psString.h
    2  *
    3  * -*- mode: C; c-basic-indent: 4; tab-width: 8; indent-tabs-mode: nil -*-
    4  * vim: set cindent ts=8 sw=4 expandtab:
    5  *
    6  *  @brief Contains the declarations of string utility functions
    7  *
    8  *  @ingroup SysUtils
    9  *
    10  *  String utility functions defined shall provide basic string copying
    11  *  capabilities.
    12  *
    13  *  @author Eric Van Alst, MHPCC
    14  *  @author David Robbins, MHPCC
    15  *
    16  *  @version $Revision: 1.34 $ $Name: not supported by cvs2svn $
    17  *  @date $Date: 2007-01-06 04:13:51 $
    18  *
    19  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     1/* @file  psString.h
     2 *
     3 * @brief string utility functions
     4 *
     5 * String utility functions defined shall provide basic string copying
     6 * capabilities.
     7 *
     8 * @author EAM, IfA
     9 * @author Eric Van Alst, MHPCC
     10 * @author David Robbins, MHPCC
     11 *
     12 * @version $Revision: 1.35 $ $Name: not supported by cvs2svn $
     13 * @date $Date: 2007-01-23 22:47:23 $
     14 *
     15 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    2016 */
    2117
    2218#ifndef PS_STRING_H
    2319#define PS_STRING_H
     20
     21/// @addtogroup SysUtils System Utilities
     22/// @{
    2423
    2524#include <sys/types.h>
    … …  
    3534const char *p_psFileLine(const char *file, int line);
    3635#define PS_FILE_LINE p_psFileLine(__FILE__,__LINE__)
    37 
    38 // Doxygen group tags
    39 
    40 /** @addtogroup SysUtils
    41  *  @{
    42  */
    4336
    4437/** Allocates a new psString.
    … …  
    230223#endif // ifndef DOXYGEN
    231224
    232 /** @} */// Doxygen - End of SystemGroup Functions
    233 
     225/// @}
    234226#endif // #ifndef PS_STRING_H

  • trunk/psLib/src/sys/psTrace.h

    r9546 r11248  
    11/** @file psTrace.h
    2  *  \brief basic run-time trace facilities
    3  *  \ingroup LogTrace
     2 *
     3 *  @brief basic run-time trace facilities
    44 *
    55 *  This file will hold the prototypes for defining procedures to insert
    … …  
    99 *  @author GLG, MHPCC
    1010 *
    11  *  @version $Revision: 1.52 $ $Name: not supported by cvs2svn $
    12  *  @date $Date: 2006-10-13 22:29:23 $
     11 *  @version $Revision: 1.53 $ $Name: not supported by cvs2svn $
     12 *  @date $Date: 2007-01-23 22:47:23 $
    1313 *
    1414 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    1515 */
    16 #if !defined(PS_TRACE_H)
     16
     17#ifndef PS_TRACE_H
    1718#define PS_TRACE_H 1
     19
     20/// @addtogroup SysUtils System Utilities
     21/// @{
     22
    1823#include <stdarg.h>
    1924
    … …  
    2126#define PS_DEFAULT_TRACE_LEVEL -1
    2227#define PS_THE_OTHER_DEFAULT_TRACE_LEVEL 0
    23 
    24 /** \addtogroup LogTrace
    25  *  \{
    26  */
    2728
    2829enum {
    … …  
    171172int psTraceGetDestination(void);
    172173
    173 /* \} */// End of SystemGroup Functions
    174 
     174/// @}
    175175#endif /* PS_NO_TRACE */
    176 
    177176#endif /* PS_TRACE_H */
    178 

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

    r9552 r11248  
    1 /** @file  psType.h
    2 *
    3 *  @brief Contains support for basic types
    4 *
    5 *  This file defines common datatypes used throughout psLib.
    6 *
    7 *  @ingroup DataContainer
    8 *
    9 *  @author Robert DeSonia, MHPCC
    10 *  @author Ross Harman, MHPCC
    11 *
    12 *  @version $Revision: 1.52 $ $Name: not supported by cvs2svn $
    13 *  @date $Date: 2006-10-14 00:02:31 $
    14 *
    15 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
    16 */
     1/* @file  psType.h
     2 *
     3 * @brief Contains support for basic types
     4 *
     5 * This file defines common datatypes used throughout psLib.
     6 *
     7 * @author Robert DeSonia, MHPCC
     8 * @author Ross Harman, MHPCC
     9 *
     10 * @version $Revision: 1.53 $ $Name: not supported by cvs2svn $
     11 * @date $Date: 2007-01-23 22:47:23 $
     12 *
     13 * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
     14 */
    1715
    1816#ifndef PS_TYPE_H
    1917#define PS_TYPE_H
     18
     19/// @addtogroup DataContainer Data Containers
     20/// @{
    2021
    2122#include <complex.h>
    … …  
    2324#include <float.h>
    2425#include <stdbool.h>
    25 
    26 /// @addtogroup DataContainer
    27 /// @{
    2826
    2927/******************************************************************************/
    … …  
    301299
    302300/// @}
    303 
    304301#endif // #ifndef PS_TYPE_H
Note: See TracChangeset for help on using the changeset viewer.