IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Changeset 530


Ignore:
Timestamp:
Apr 27, 2004, 9:24:32 AM (22 years ago)
Author:
evanalst
Message:

Added Doxygen tags for grouping functions into system utilities group.

Location:
trunk/psLib/src
Files:
6 edited

Legend:

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

    r432 r530  
    11/** @file  psAbort.h
     2 *
     3 *  @ingroup SystemGroup System Utilities
    24 *
    35 *  @brief Contains the declarations for the abort function
     
    911 *  @author Eric Van Alst, MHPCC
    1012 *   
    11  *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    12  *  @date $Date: 2004-04-16 02:18:57 $
     13 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     14 *  @date $Date: 2004-04-27 19:24:32 $
    1315 *
    1416 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    1517 */
    1618
    17 #ifndef PSABORT_H
    18 #define PSABORT_H
     19#ifndef PS_ABORT_H
     20#define PS_ABORT_H
    1921
    2022/******************************************************************************/
     
    3436/*****************************************************************************/
    3537
     38// Doxygen grouping tags
     39/** @addtogroup SystemGroup System Utilities
     40 *  @{
     41 */
     42
    3643/** Reports an abort message to logging facility
    3744 *
     
    5057);
    5158
     59/* @} */  // Doxygen - End of SystemGroup Functions
     60
    5261#endif
    5362
  • trunk/psLib/src/sys/psError.h

    r432 r530  
    22 *
    33 *  @brief Contains the declarations for the error reporting functions
     4 *
     5 *  @ingroup SystemGroup
    46 *
    57 *  Error reporting functions shall be used to create log entries in the
     
    1012 *  @author Eric Van Alst, MHPCC
    1113 *   
    12  *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    13  *  @date $Date: 2004-04-16 02:18:57 $
     14 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     15 *  @date $Date: 2004-04-27 19:24:32 $
    1416 *
    1517 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    1618 */
    1719
    18 #ifndef PSERROR_H
    19 #define PSERROR_H
     20#ifndef PS_ERROR_H
     21#define PS_ERROR_H
    2022
    2123/******************************************************************************/
     
    3537/*****************************************************************************/
    3638
     39/** @addtogroup SystemGroup System Utilities
     40 *  @{
     41 */
     42
    3743/** Reports an error message to the logging facility
    3844 *
     
    5056);
    5157
     58/* @} */  // End of SystemGroup Functions
     59
    5260#endif
    5361
  • trunk/psLib/src/sys/psString.h

    r463 r530  
    22 *
    33 *  @brief Contains the declarations of string utility functions
     4 *
     5 *  @ingroup SystemGroup
    46 *
    57 *  String utility functions defined shall provide basic string copying
     
    810 *  @author Eric Van Alst, MHPCC
    911 *   
    10  *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    11  *  @date $Date: 2004-04-20 02:30:07 $
     12 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     13 *  @date $Date: 2004-04-27 19:24:32 $
    1214 *
    1315 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
     
    3335/* FUNCTION PROTOTYPES                                                       */
    3436/*****************************************************************************/
     37
     38// Doxygen group tags
     39/** @addtogroup SystemGroup System Utilities
     40 *  @{
     41 */
    3542
    3643/** Copies the input string
     
    6572);
    6673
     74/* @} */  // Doxygen - End of SystemGroup Functions
     75
    6776#endif
    6877
  • trunk/psLib/src/sysUtils/psAbort.h

    r432 r530  
    11/** @file  psAbort.h
     2 *
     3 *  @ingroup SystemGroup System Utilities
    24 *
    35 *  @brief Contains the declarations for the abort function
     
    911 *  @author Eric Van Alst, MHPCC
    1012 *   
    11  *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    12  *  @date $Date: 2004-04-16 02:18:57 $
     13 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     14 *  @date $Date: 2004-04-27 19:24:32 $
    1315 *
    1416 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    1517 */
    1618
    17 #ifndef PSABORT_H
    18 #define PSABORT_H
     19#ifndef PS_ABORT_H
     20#define PS_ABORT_H
    1921
    2022/******************************************************************************/
     
    3436/*****************************************************************************/
    3537
     38// Doxygen grouping tags
     39/** @addtogroup SystemGroup System Utilities
     40 *  @{
     41 */
     42
    3643/** Reports an abort message to logging facility
    3744 *
     
    5057);
    5158
     59/* @} */  // Doxygen - End of SystemGroup Functions
     60
    5261#endif
    5362
  • trunk/psLib/src/sysUtils/psError.h

    r432 r530  
    22 *
    33 *  @brief Contains the declarations for the error reporting functions
     4 *
     5 *  @ingroup SystemGroup
    46 *
    57 *  Error reporting functions shall be used to create log entries in the
     
    1012 *  @author Eric Van Alst, MHPCC
    1113 *   
    12  *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    13  *  @date $Date: 2004-04-16 02:18:57 $
     14 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     15 *  @date $Date: 2004-04-27 19:24:32 $
    1416 *
    1517 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    1618 */
    1719
    18 #ifndef PSERROR_H
    19 #define PSERROR_H
     20#ifndef PS_ERROR_H
     21#define PS_ERROR_H
    2022
    2123/******************************************************************************/
     
    3537/*****************************************************************************/
    3638
     39/** @addtogroup SystemGroup System Utilities
     40 *  @{
     41 */
     42
    3743/** Reports an error message to the logging facility
    3844 *
     
    5056);
    5157
     58/* @} */  // End of SystemGroup Functions
     59
    5260#endif
    5361
  • trunk/psLib/src/sysUtils/psString.h

    r463 r530  
    22 *
    33 *  @brief Contains the declarations of string utility functions
     4 *
     5 *  @ingroup SystemGroup
    46 *
    57 *  String utility functions defined shall provide basic string copying
     
    810 *  @author Eric Van Alst, MHPCC
    911 *   
    10  *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    11  *  @date $Date: 2004-04-20 02:30:07 $
     12 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     13 *  @date $Date: 2004-04-27 19:24:32 $
    1214 *
    1315 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
     
    3335/* FUNCTION PROTOTYPES                                                       */
    3436/*****************************************************************************/
     37
     38// Doxygen group tags
     39/** @addtogroup SystemGroup System Utilities
     40 *  @{
     41 */
    3542
    3643/** Copies the input string
     
    6572);
    6673
     74/* @} */  // Doxygen - End of SystemGroup Functions
     75
    6776#endif
    6877
Note: See TracChangeset for help on using the changeset viewer.