IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Changeset 978


Ignore:
Timestamp:
Jun 9, 2004, 4:09:57 PM (22 years ago)
Author:
desonia
Message:

doxygen tweaks.

Location:
trunk/psLib/src
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • trunk/psLib/src/Doxyfile

    r974 r978  
    369369
    370370# If the value of the INPUT tag contains directories, you can use the
    371 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
    372 # and *.h) to filter out the source-files in the directories. If left 
    373 # blank the following patterns are tested: 
    374 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 
     371# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
     372# and *.h) to filter out the source-files in the directories. If left
     373# blank the following patterns are tested:
     374# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
    375375# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
    376376
    377 FILE_PATTERNS          =
    378 
    379 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
    380 # should be searched for input files as well. Possible values are YES and NO. 
     377FILE_PATTERNS          = *.h *.dox
     378
     379# The RECURSIVE tag can be used to turn specify whether or not subdirectories
     380# should be searched for input files as well. Possible values are YES and NO.
    381381# If left blank NO is used.
    382382
  • trunk/psLib/src/dataManip/psStats.c

    r893 r978  
    2828#define MYMAXFLOAT 1e99
    2929
     30#ifndef DOXYGEN
    3031void p_psVectorRobustStats(const psVector *restrict myVector,
    3132                           const psVector *restrict maskVector,
    3233                           unsigned int maskVal,
    3334                           psStats *stats);
     35#endif
     36
    3437/******************************************************************************
    3538    psStatsAlloc(): This routine must create a new psStats data structure.
  • trunk/psLib/src/math/psStats.c

    r893 r978  
    2828#define MYMAXFLOAT 1e99
    2929
     30#ifndef DOXYGEN
    3031void p_psVectorRobustStats(const psVector *restrict myVector,
    3132                           const psVector *restrict maskVector,
    3233                           unsigned int maskVal,
    3334                           psStats *stats);
     35#endif
     36
    3437/******************************************************************************
    3538    psStatsAlloc(): This routine must create a new psStats data structure.
  • trunk/psLib/src/sys/psMemory.h

    r974 r978  
    1414 *  @ingroup MemoryManagement
    1515 *
    16  *  @version $Revision: 1.17 $ $Name: not supported by cvs2svn $
    17  *  @date $Date: 2004-06-10 01:58:06 $
     16 *  @version $Revision: 1.18 $ $Name: not supported by cvs2svn $
     17 *  @date $Date: 2004-06-10 02:09:57 $
    1818 *
    1919 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
     
    3131 *
    3232 *  Routines dealing with the creating and setting of memory management callback functions.
     33 */
     34
     35/**
     36 *  @addtogroup memTracing Memory Tracing
     37 *
     38 *  Routines dealing with memory tracing and corruption checking.
    3339 */
    3440
     
    182188 *              blocks above id0 that have not been freed.
    183189 *  @see psAlloc, psFree, psgetMemId, psMemProblemCallbackSet
     190 *  @ingroup memTracing
    184191 */
    185192int psMemCheckLeaks(
     
    192199 *  i.e., invalid markers that signify a buffer under/overflow.
    193200 *
     201 *  @ingroup memTracing
    194202 */
    195203int psMemCheckCorruption(
     
    276284#define PS_FREE     (void*)1
    277285
     286//@} End of Memory Management Functions
     287
     288
     289#ifndef DOXYGEN
     290
    278291void p_psCustomFree(psFreeFcn fcn,void* ptr);
    279 
    280 //@} End of Memory Management Functions
    281 
    282 #ifndef DOXYGEN
    283292
    284293/*
  • trunk/psLib/src/sys/psTrace.h

    r974 r978  
    3030/** Functions **************************************************************/
    3131
     32#ifndef DOXYGEN
    3233/// Send a trace message
    3334void p_psTrace(const char *facil,  ///< facilty of interest
     
    3536               ...)   ///< trace message arguments
    3637;
     38#endif
    3739
    3840/// Set trace level
  • trunk/psLib/src/sysUtils/psMemory.h

    r974 r978  
    1414 *  @ingroup MemoryManagement
    1515 *
    16  *  @version $Revision: 1.17 $ $Name: not supported by cvs2svn $
    17  *  @date $Date: 2004-06-10 01:58:06 $
     16 *  @version $Revision: 1.18 $ $Name: not supported by cvs2svn $
     17 *  @date $Date: 2004-06-10 02:09:57 $
    1818 *
    1919 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
     
    3131 *
    3232 *  Routines dealing with the creating and setting of memory management callback functions.
     33 */
     34
     35/**
     36 *  @addtogroup memTracing Memory Tracing
     37 *
     38 *  Routines dealing with memory tracing and corruption checking.
    3339 */
    3440
     
    182188 *              blocks above id0 that have not been freed.
    183189 *  @see psAlloc, psFree, psgetMemId, psMemProblemCallbackSet
     190 *  @ingroup memTracing
    184191 */
    185192int psMemCheckLeaks(
     
    192199 *  i.e., invalid markers that signify a buffer under/overflow.
    193200 *
     201 *  @ingroup memTracing
    194202 */
    195203int psMemCheckCorruption(
     
    276284#define PS_FREE     (void*)1
    277285
     286//@} End of Memory Management Functions
     287
     288
     289#ifndef DOXYGEN
     290
    278291void p_psCustomFree(psFreeFcn fcn,void* ptr);
    279 
    280 //@} End of Memory Management Functions
    281 
    282 #ifndef DOXYGEN
    283292
    284293/*
  • trunk/psLib/src/sysUtils/psTrace.h

    r974 r978  
    3030/** Functions **************************************************************/
    3131
     32#ifndef DOXYGEN
    3233/// Send a trace message
    3334void p_psTrace(const char *facil,  ///< facilty of interest
     
    3536               ...)   ///< trace message arguments
    3637;
     38#endif
    3739
    3840/// Set trace level
Note: See TracChangeset for help on using the changeset viewer.