IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Jun 9, 2004, 3:58:06 PM (22 years ago)
Author:
desonia
Message:

Added doxygen group tags.

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

Legend:

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

    r530 r974  
    11/** @file  psAbort.h
    2  *
    3  *  @ingroup SystemGroup System Utilities
    42 *
    53 *  @brief Contains the declarations for the abort function
     
    97 *  needing to abort from program execution.
    108 *
     9 *  @ingroup ErrorHandling
     10 *
    1111 *  @author Eric Van Alst, MHPCC
    12  *   
    13  *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
    14  *  @date $Date: 2004-04-27 19:24:32 $
     12 *
     13 *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
     14 *  @date $Date: 2004-06-10 01:58:06 $
    1515 *
    1616 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
     
    2020#define PS_ABORT_H
    2121
    22 /******************************************************************************/
    23 /*  DEFINE STATEMENTS                                                         */
    24 /******************************************************************************/
    25 
    26 // None
    27 
    28 /******************************************************************************/
    29 /*  TYPE DEFINITIONS                                                          */
    30 /******************************************************************************/
    31 
    32 // None
    33 
    34 /*****************************************************************************/
    35 /* FUNCTION PROTOTYPES                                                       */
    36 /*****************************************************************************/
    3722
    3823// Doxygen grouping tags
    39 /** @addtogroup SystemGroup System Utilities
     24/** @addtogroup ErrorHandling
    4025 *  @{
    4126 */
  • trunk/psLib/src/sysUtils/psError.h

    r530 r974  
    22 *
    33 *  @brief Contains the declarations for the error reporting functions
    4  *
    5  *  @ingroup SystemGroup
    64 *
    75 *  Error reporting functions shall be used to create log entries in the
     
    108 *  of error detected.
    119 *
     10 *  @ingroup ErrorHandling
     11 *
    1212 *  @author Eric Van Alst, MHPCC
    13  *   
    14  *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
    15  *  @date $Date: 2004-04-27 19:24:32 $
     13 *
     14 *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
     15 *  @date $Date: 2004-06-10 01:58:06 $
    1616 *
    1717 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
     
    2121#define PS_ERROR_H
    2222
    23 /******************************************************************************/
    24 /*  DEFINE STATEMENTS                                                         */
    25 /******************************************************************************/
    26 
    27 // None
    28 
    29 /******************************************************************************/
    30 /*  TYPE DEFINITIONS                                                          */
    31 /******************************************************************************/
    32 
    33 // None
    34 
    35 /*****************************************************************************/
    36 /* FUNCTION PROTOTYPES                                                       */
    37 /*****************************************************************************/
    38 
    39 /** @addtogroup SystemGroup System Utilities
     23/** @addtogroup ErrorHandling
    4024 *  @{
    4125 */
     
    5640);
    5741
    58 /* @} */  // End of SystemGroup Functions
     42/* @} */  // End of SysUtils Functions
    5943
    6044#endif
  • trunk/psLib/src/sysUtils/psHash.h

    r969 r974  
    1212 *  @author George Gusciora, MHPCC
    1313 *   
    14  *  @version $Revision: 1.10 $ $Name: not supported by cvs2svn $
    15  *  @date $Date: 2004-06-10 01:31:05 $
     14 *  @version $Revision: 1.11 $ $Name: not supported by cvs2svn $
     15 *  @date $Date: 2004-06-10 01:58:06 $
    1616 *
    1717 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
     
    2121#define PS_HASH_H
    2222
    23 /** \addtogroup HashTable Hash Table
     23/** \addtogroup HashTable
    2424 *  \{
    2525 */
  • trunk/psLib/src/sysUtils/psLogMsg.h

    r964 r974  
    11#if !defined(PS_LOG_MSG_H)
    22#define PS_LOG_MSG_H
    3 #endif
    43
    54/** \file psLogMsg.h
    65 *  \brief log messaging facilities
    7  *  \ingroup SystemGroup
     6 *  \ingroup LogTrace
    87 */
    98
    109#include <stdarg.h>
    1110
    12 /** Functions **************************************************************/
    13 /** \addtogroup SystemGroup System Utilities
    14  *  \{
     11/** @addtogroup LogTrace
     12 *  @{
    1513 */
    1614
     
    5654;
    5755
    58 /* \} */ // End of SystemGroup Functions
    5956
    6057///< Status codes for log messages
     
    7168    PS_LOG_TO_STDOUT };
    7269
     70/// @}
     71
     72#endif
  • trunk/psLib/src/sysUtils/psMemory.h

    r876 r974  
    1212 *  @author Robert Lupton, Princeton University
    1313 *
    14  *  @version $Revision: 1.16 $ $Name: not supported by cvs2svn $
    15  *  @date $Date: 2004-06-04 23:46:48 $
    16  *
    17  *  @ingroup SystemGroup System Utilities
     14 *  @ingroup MemoryManagement
     15 *
     16 *  @version $Revision: 1.17 $ $Name: not supported by cvs2svn $
     17 *  @date $Date: 2004-06-10 01:58:06 $
    1818 *
    1919 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
     
    2121
    2222#include <stdio.h>                      // needed for FILE
    23 #include <pthread.h>                   // we need a mutex to make this stuff thread safe.
    24 
    25 /** @addtogroup MemoryManagement Memory Management Utilities
    26  *  @ingroup SystemGroup
    27  *
    28  *  This is the generic memory management system put inbetween the user's high level code and the OS-level
    29  *  memory allocation routines.  This system adds such features as callback routines for memory error events,
    30  *  tracing capabilities, and reference counting.
     23#include <pthread.h>                    // we need a mutex to make this stuff thread safe.
     24
     25/** @addtogroup MemoryManagement
    3126 *  @{
    3227 */
  • trunk/psLib/src/sysUtils/psString.h

    r545 r974  
    33 *  @brief Contains the declarations of string utility functions
    44 *
    5  *  @ingroup SystemGroup
     5 *  @ingroup SysUtils
    66 *
    77 *  String utility functions defined shall provide basic string copying
     
    99 *
    1010 *  @author Eric Van Alst, MHPCC
    11  *   
    12  *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
    13  *  @date $Date: 2004-04-28 22:19:20 $
     11 *
     12 *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     13 *  @date $Date: 2004-06-10 01:58:06 $
    1414 *
    1515 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
     
    3737
    3838// Doxygen group tags
    39 /** @addtogroup SystemGroup System Utilities
     39/** @addtogroup SysUtils
    4040 *  @{
    4141 */
  • trunk/psLib/src/sysUtils/psTrace.h

    r928 r974  
    66/** \file psTrace.h
    77 *  \brief basic run-time trace facilities
    8  *  \ingroup SystemGroup
     8 *  \ingroup LogTrace
    99 */
    1010
     
    2323Component;
    2424
    25 /** Functions **************************************************************/
    26 /** \addtogroup SystemGroup System Utilities
     25/** \addtogroup LogTrace
    2726 *  \{
    2827 */
     28
     29
     30/** Functions **************************************************************/
    2931
    3032/// Send a trace message
  • trunk/psLib/src/sysUtils/psType.h

    r831 r974  
    55 *  This file defines common datatypes used throughout psLib.
    66 *
     7 *  @ingroup DataContainer
     8 *
    79 *  @author Robert DeSonia, MHPCC
    810 *  @author Ross Harman, MHPCC
    911 *
    10  *  @version $Revision: 1.10 $ $Name: not supported by cvs2svn $
    11  *  @date $Date: 2004-06-02 23:29:14 $
     12 *  @version $Revision: 1.11 $ $Name: not supported by cvs2svn $
     13 *  @date $Date: 2004-06-10 01:58:06 $
    1214 *
    1315 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
     
    1921#include <complex.h>
    2022#include <stdint.h>
     23
     24/// @addtogroup DataContainer
     25/// @{
    2126
    2227/******************************************************************************/
     
    114119psType;
    115120
     121/// @}
     122
    116123#endif
Note: See TracChangeset for help on using the changeset viewer.