IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Changeset 974


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

Added doxygen group tags.

Location:
trunk/psLib/src
Files:
40 edited

Legend:

Unmodified
Added
Removed

  • trunk/psLib/src/Doxyfile

    r648 r974  
    2020PROJECT_NAME           = "Pan-STARRS Foundation Library"
    2121
    22 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
    23 # This could be handy for archiving the generated documentation or 
     22# The PROJECT_NUMBER tag can be used to enter a project or revision number.
     23# This could be handy for archiving the generated documentation or
    2424# if some version control system is used.
    2525
    2626PROJECT_NUMBER         = "$Name: not supported by cvs2svn $"
    2727
    28 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
    29 # base path where the generated documentation will be put. 
    30 # If a relative path is entered, it will be relative to the location 
     28# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
     29# base path where the generated documentation will be put.
     30# If a relative path is entered, it will be relative to the location
    3131# where doxygen was started. If left blank the current directory will be used.
    3232
    3333OUTPUT_DIRECTORY       = ../docs
    3434
    35 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
    36 # documentation generated by doxygen is written. Doxygen will use this 
    37 # information to generate all constant output in the proper language. 
    38 # The default language is English, other supported languages are: 
    39 # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, 
    40 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en 
    41 # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese, 
     35# The OUTPUT_LANGUAGE tag is used to specify the language in which all
     36# documentation generated by doxygen is written. Doxygen will use this
     37# information to generate all constant output in the proper language.
     38# The default language is English, other supported languages are:
     39# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
     40# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
     41# (Japanese with English messages), Korean, Norwegian, Polish, Portuguese,
    4242# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
    4343
    4444OUTPUT_LANGUAGE        = English
    4545
    46 # This tag can be used to specify the encoding used in the generated output. 
    47 # The encoding is not always determined by the language that is chosen, 
    48 # but also whether or not the output is meant for Windows or non-Windows users. 
    49 # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES 
    50 # forces the Windows encoding (this is the default for the Windows binary), 
    51 # whereas setting the tag to NO uses a Unix-style encoding (the default for 
     46# This tag can be used to specify the encoding used in the generated output.
     47# The encoding is not always determined by the language that is chosen,
     48# but also whether or not the output is meant for Windows or non-Windows users.
     49# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
     50# forces the Windows encoding (this is the default for the Windows binary),
     51# whereas setting the tag to NO uses a Unix-style encoding (the default for
    5252# all platforms other than Windows).
    5353
    5454USE_WINDOWS_ENCODING   = NO
    5555
    56 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
    57 # include brief member descriptions after the members that are listed in 
    58 # the file and class documentation (similar to JavaDoc). 
     56# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
     57# include brief member descriptions after the members that are listed in
     58# the file and class documentation (similar to JavaDoc).
    5959# Set to NO to disable this.
    6060
    6161BRIEF_MEMBER_DESC      = YES
    6262
    63 # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
    64 # the brief description of a member or function before the detailed description. 
    65 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
     63# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
     64# the brief description of a member or function before the detailed description.
     65# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
    6666# brief descriptions will be completely suppressed.
    6767
    6868REPEAT_BRIEF           = YES
    6969
    70 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
    71 # Doxygen will generate a detailed section even if there is only a brief 
     70# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
     71# Doxygen will generate a detailed section even if there is only a brief
    7272# description.
    7373
    7474ALWAYS_DETAILED_SEC    = YES
    7575
    76 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited 
    77 # members of a class in the documentation of that class as if those members were 
    78 # ordinary class members. Constructors, destructors and assignment operators of 
     76# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
     77# members of a class in the documentation of that class as if those members were
     78# ordinary class members. Constructors, destructors and assignment operators of
    7979# the base classes will not be shown.
    8080
    8181INLINE_INHERITED_MEMB  = NO
    8282
    83 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
    84 # path before files name in the file list and in the header files. If set 
     83# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
     84# path before files name in the file list and in the header files. If set
    8585# to NO the shortest path that makes the file name unique will be used.
    8686
    8787FULL_PATH_NAMES        = NO
    8888
    89 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
    90 # can be used to strip a user-defined part of the path. Stripping is 
    91 # only done if one of the specified strings matches the left-hand part of 
     89# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
     90# can be used to strip a user-defined part of the path. Stripping is
     91# only done if one of the specified strings matches the left-hand part of
    9292# the path. It is allowed to use relative paths in the argument list.
    9393
    94 STRIP_FROM_PATH        = 
    95 
    96 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
    97 # (but less readable) file names. This can be useful is your file systems 
     94STRIP_FROM_PATH        =
     95
     96# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
     97# (but less readable) file names. This can be useful is your file systems
    9898# doesn't support long names like on DOS, Mac, or CD-ROM.
    9999
    100100SHORT_NAMES            = NO
    101101
    102 # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
    103 # will interpret the first line (until the first dot) of a JavaDoc-style 
    104 # comment as the brief description. If set to NO, the JavaDoc 
    105 # comments will behave just like the Qt-style comments (thus requiring an 
     102# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
     103# will interpret the first line (until the first dot) of a JavaDoc-style
     104# comment as the brief description. If set to NO, the JavaDoc
     105# comments will behave just like the Qt-style comments (thus requiring an
    106106# explict @brief command for a brief description.
    107107
    108108JAVADOC_AUTOBRIEF      = YES
    109109
    110 # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
    111 # treat a multi-line C++ special comment block (i.e. a block of //! or /// 
    112 # comments) as a brief description. This used to be the default behaviour. 
    113 # The new default is to treat a multi-line C++ comment block as a detailed 
     110# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
     111# treat a multi-line C++ special comment block (i.e. a block of //! or ///
     112# comments) as a brief description. This used to be the default behaviour.
     113# The new default is to treat a multi-line C++ comment block as a detailed
    114114# description. Set this tag to YES if you prefer the old behaviour instead.
    115115
    116116MULTILINE_CPP_IS_BRIEF = NO
    117117
    118 # If the DETAILS_AT_TOP tag is set to YES then Doxygen 
     118# If the DETAILS_AT_TOP tag is set to YES then Doxygen
    119119# will output the detailed description near the top, like JavaDoc.
    120 # If set to NO, the detailed description appears after the member 
     120# If set to NO, the detailed description appears after the member
    121121# documentation.
    122122
    123123DETAILS_AT_TOP         = YES
    124124
    125 # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
    126 # member inherits the documentation from any documented member that it 
     125# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
     126# member inherits the documentation from any documented member that it
    127127# reimplements.
    128128
    129129INHERIT_DOCS           = YES
    130130
    131 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
    132 # tag is set to YES, then doxygen will reuse the documentation of the first 
    133 # member in the group (if any) for the other members of the group. By default 
     131# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
     132# tag is set to YES, then doxygen will reuse the documentation of the first
     133# member in the group (if any) for the other members of the group. By default
    134134# all members of a group must be documented explicitly.
    135135
    136136DISTRIBUTE_GROUP_DOC   = NO
    137137
    138 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
     138# The TAB_SIZE tag can be used to set the number of spaces in a tab.
    139139# Doxygen uses this value to replace tabs by spaces in code fragments.
    140140
    141141TAB_SIZE               = 4
    142142
    143 # This tag can be used to specify a number of aliases that acts 
    144 # as commands in the documentation. An alias has the form "name=value". 
    145 # For example adding "sideeffect=\par Side Effects:\n" will allow you to 
     143# This tag can be used to specify a number of aliases that acts
     144# as commands in the documentation. An alias has the form "name=value".
     145# For example adding "sideeffect=\par Side Effects:\n" will allow you to
    146146# put the command \sideeffect (or @sideeffect) in the documentation, which
    147 # will result in a user-defined paragraph with heading "Side Effects:". 
     147# will result in a user-defined paragraph with heading "Side Effects:".
    148148# You can put \n's in the value part of an alias to insert newlines.
    149149
    150150ALIASES                =
    151151
    152 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 
    153 # only. Doxygen will then generate output that is more tailored for C. 
    154 # For instance, some of the names that are used will be different. The list 
     152# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
     153# only. Doxygen will then generate output that is more tailored for C.
     154# For instance, some of the names that are used will be different. The list
    155155# of all members will be omitted, etc.
    156156
    157157OPTIMIZE_OUTPUT_FOR_C  = YES
    158158
    159 # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources 
    160 # only. Doxygen will then generate output that is more tailored for Java. 
    161 # For instance, namespaces will be presented as packages, qualified scopes 
     159# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
     160# only. Doxygen will then generate output that is more tailored for Java.
     161# For instance, namespaces will be presented as packages, qualified scopes
    162162# will look different, etc.
    163163
    … …  
    165165
    166166# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
    167 # the same type (for instance a group of public functions) to be put as a 
    168 # subgroup of that type (e.g. under the Public Functions section). Set it to 
    169 # NO to prevent subgrouping. Alternatively, this can be done per class using 
     167# the same type (for instance a group of public functions) to be put as a
     168# subgroup of that type (e.g. under the Public Functions section). Set it to
     169# NO to prevent subgrouping. Alternatively, this can be done per class using
    170170# the \nosubgrouping command.
    171171
    … …  
    176176#---------------------------------------------------------------------------
    177177
    178 # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
    179 # documentation are documented, even if no documentation was available. 
    180 # Private class members and static file members will be hidden unless 
     178# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
     179# documentation are documented, even if no documentation was available.
     180# Private class members and static file members will be hidden unless
    181181# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
    182182
    183183EXTRACT_ALL            = YES
    184184
    185 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
     185# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
    186186# will be included in the documentation.
    187187
    188188EXTRACT_PRIVATE        = NO
    189189
    190 # If the EXTRACT_STATIC tag is set to YES all static members of a file 
     190# If the EXTRACT_STATIC tag is set to YES all static members of a file
    191191# will be included in the documentation.
    192192
    193193EXTRACT_STATIC         = NO
    194194
    195 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
    196 # defined locally in source files will be included in the documentation. 
     195# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
     196# defined locally in source files will be included in the documentation.
    197197# If set to NO only classes defined in header files are included.
    198198
    199199EXTRACT_LOCAL_CLASSES  = NO
    200200
    201 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
    202 # undocumented members of documented classes, files or namespaces. 
    203 # If set to NO (the default) these members will be included in the 
    204 # various overviews, but no documentation section is generated. 
     201# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
     202# undocumented members of documented classes, files or namespaces.
     203# If set to NO (the default) these members will be included in the
     204# various overviews, but no documentation section is generated.
    205205# This option has no effect if EXTRACT_ALL is enabled.
    206206
    207207HIDE_UNDOC_MEMBERS     = NO
    208208
    209 # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
    210 # undocumented classes that are normally visible in the class hierarchy. 
    211 # If set to NO (the default) these classes will be included in the various 
     209# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
     210# undocumented classes that are normally visible in the class hierarchy.
     211# If set to NO (the default) these classes will be included in the various
    212212# overviews. This option has no effect if EXTRACT_ALL is enabled.
    213213
    214214HIDE_UNDOC_CLASSES     = NO
    215215
    216 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
    217 # friend (class|struct|union) declarations. 
    218 # If set to NO (the default) these declarations will be included in the 
     216# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
     217# friend (class|struct|union) declarations.
     218# If set to NO (the default) these declarations will be included in the
    219219# documentation.
    220220
    … …  
    230230# The INTERNAL_DOCS tag determines if documentation
    231231# that is typed after a \internal command is included. If the tag is set
    232 # to NO (the default) then the documentation will be excluded. 
     232# to NO (the default) then the documentation will be excluded.
    233233# Set it to YES to include the internal documentation.
    234234
    … …  
    298298# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
    299299# the initial value of a variable or define consists of for it to appear in
    300 # the documentation. If the initializer consists of more lines than specified 
     300# the documentation. If the initializer consists of more lines than specified
    301301# here it will be hidden. Use a value of 0 to hide initializers completely.
    302302# The appearance of the initializer of individual variables and defines in the
    … …  
    322322
    323323# The WARNINGS tag can be used to turn on/off the warning messages that are
    324 # generated by doxygen. Possible values are YES and NO. If left blank 
     324# generated by doxygen. Possible values are YES and NO. If left blank
    325325# NO is used.
    326326
    … …  
    362362# with spaces.
    363363
    364 INPUT                  = mainpage.dox \
     364INPUT                  = pslib.h \
     365                         mainpage.dox \
    365366                         sysUtils \
    366367                         dataManip \
    … …  
    374375# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
    375376
    376 FILE_PATTERNS          = 
     377FILE_PATTERNS          =
    377378
    378379# The RECURSIVE tag can be used to turn specify whether or not subdirectories
    … …  
    382383RECURSIVE              = YES
    383384
    384 # The EXCLUDE tag can be used to specify files and/or directories that should 
     385# The EXCLUDE tag can be used to specify files and/or directories that should
    385386# excluded from the INPUT source files. This way you can easily exclude a
    386387# subdirectory from a directory tree whose root is specified with the INPUT tag.

  • trunk/psLib/src/collections/psBitSet.h

    r966 r974  
    88 *  string.
    99 *
     10 *  @ingroup BitSet
     11 *
    1012 *  @author Ross Harman, MHPCC
    1113 *
    12  *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
    13  *  @date $Date: 2004-06-10 00:29:57 $
     14 *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     15 *  @date $Date: 2004-06-10 01:58:06 $
    1416 *
    1517 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    1820#ifndef PSBITSET_H
    1921#define PSBITSET_H
     22
     23/// @addtogroup BitSet
     24/// @{
    2025
    2126/******************************************************************************/
    … …  
    111116);
    112117
     118/// @}
     119
    113120#endif

  • trunk/psLib/src/collections/psList.h

    r942 r974  
    44/** @file psList.h
    55 *  @brief Support for doubly linked lists
    6  *  @ingroup DataContainers
    76 *
    87 *  @author Robert Lupton, Princeton University
    98 *  @author Robert Daniel DeSonia, MHPCC
    109 *
    11  *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    12  *  @date $Date: 2004-06-09 02:16:41 $
     10 *  @ingroup LinkedList
     11 *
     12 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     13 *  @date $Date: 2004-06-10 01:58:06 $
    1314 *
    1415 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    1819
    1920#include "psVector.h"
     21
     22/** @addtogroup LinkedList
     23 *  @{
     24 */
    2025
    2126/** Special values of index into list
    … …  
    5459}
    5560psList;
    56 
    57 /** @addtogroup DataContainers General Data Container Utilities
    58  *  @{
    59  */
    6061
    6162/** Constructor */

  • trunk/psLib/src/collections/psSort.h

    r945 r974  
    1212 *  in the sorted array is undefined.
    1313 *
     14 *  @ingroup Sort
     15 *
    1416 *  @author Ross Harman, MHPCC
    1517 *
    16  *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
    17  *  @date $Date: 2004-06-09 18:23:22 $
     18 *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     19 *  @date $Date: 2004-06-10 01:58:06 $
    1820 *
    1921 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    2224#ifndef PSSORT_H
    2325#define PSSORT_H
     26
     27/// @addtogroup Sort
     28/// @{
    2429
    2530/******************************************************************************/
    … …  
    5863psVector *psSortIndex(psVector *restrict outVector, const psVector *restrict inVector);
    5964
     65/// @}
     66
    6067#endif

  • trunk/psLib/src/collections/psVector.h

    r836 r974  
    66 *  in manupulating vectors.
    77 *
     8 *  @ingroup Vector
     9 *
    810 *  @author Robert DeSonia, MHPCC
    911 *  @author Ross Harman, MHPCC
    1012 *
    11  *  @version $Revision: 1.9 $ $Name: not supported by cvs2svn $
    12  *  @date $Date: 2004-06-03 00:32:32 $
     13 *  @version $Revision: 1.10 $ $Name: not supported by cvs2svn $
     14 *  @date $Date: 2004-06-10 01:58:06 $
    1315 *
    1416 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    1921
    2022#include "psType.h"
     23
     24/// @addtogroup Vector
     25/// @{
    2126
    2227/** An vector to support primitive types.
    … …  
    121126);
    122127
     128/// @}
     129
    123130#endif

  • trunk/psLib/src/dataManip/psFFT.h

    r828 r974  
    33 *  @brief Contains FFT transforms functions
    44 *
     5 *  @ingroup Transform
     6 *
    57 *  @author Robert DeSonia, MHPCC
    68 *
    7  *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
    8  *  @date $Date: 2004-06-02 19:41:57 $
     9 *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     10 *  @date $Date: 2004-06-10 01:58:06 $
    911 *
    1012 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    1618#include "psImage.h"
    1719#include "psVector.h"
     20
     21/// @addtogroup Transform
     22/// @{
    1823
    1924/** Details on FFT implementation (private). */
    … …  
    4247psVector* psVectorPowerSpectrum(psVector* out, const psVector* in);
    4348
     49/// @}
    4450
    4551#endif

  • trunk/psLib/src/dataManip/psFunctions.h

    r889 r974  
    33
    44/** \file psFunctions.h
    5  *  \brief Standard Mathematical Functions.
    6  *  \ingroup MathGroup
     5 *  \brief Standard Mathematical Functions.
     6 *  \ingroup Stats
     7 */
     8
     9/** \addtogroup Stats
     10 *  \{
    711 */
    812
    … …  
    6771
    6872/** Functions **************************************************************/
    69 /** \addtogroup MathGroup Math Utilities
    70  *  \{
    71  */
    7273
    7374/** Constructor */
    … …  
    129130                  );
    130131
    131 /* \} */ // End of MathGroup Functions
    132 
    133132/*****************************************************************************/
    134133
    … …  
    174173}
    175174psDPolynomial4D;
    176 
    177 /** Functions **************************************************************/
    178 /** \addtogroup MathGroup Math Utilities
    179  *  \{
    180  */
    181175
    182176/** Constructor */

  • trunk/psLib/src/dataManip/psMatrix.h

    r908 r974  
    1717 *  operate only with the psF64 data type.
    1818 *
     19 *  @ingroup Matrix
     20 *
    1921 *  @author Ross Harman, MHPCC
    20  *   
    21  *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
    22  *  @date $Date: 2004-06-08 01:58:03 $
     22 *
     23 *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     24 *  @date $Date: 2004-06-10 01:58:06 $
    2325 *
    2426 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    2830#define PSMATRIX_H
    2931
    30 /******************************************************************************/
    31 /*  DEFINE STATEMENTS                                                         */
    32 /******************************************************************************/
    33 
    34 // None
    35 
    36 /******************************************************************************/
    37 /*  TYPE DEFINITIONS                                                          */
    38 /******************************************************************************/
    39 
    40 // None
    41 
    42 /*****************************************************************************/
    43 /* FUNCTION PROTOTYPES                                                       */
    44 /*****************************************************************************/
     32/// @addtogroup Matrix
     33/// @{
    4534
    4635/** LU Decomposition of psImage matrix.
    4736 *
    48  *  Performs a LU decomposition on a psImage matrix and returns the LU matrix. If the user specifies NULL for 
     37 *  Performs a LU decomposition on a psImage matrix and returns the LU matrix. If the user specifies NULL for
    4938 *  the outImage or outPerm arguments, then they will be automatically created. The input image must
    5039 *  be square. This function operates only with the psF64 data type. Input and output arguments should not be
    … …  
    7766/** Invert psImage matrix.
    7867 *
    79  *  Inverts a psImage matrix and returns the determinant as an option through the argument list. If the user 
     68 *  Inverts a psImage matrix and returns the determinant as an option through the argument list. If the user
    8069 *  specifies NULL as the outImage argument, then it will automatically be created. The input image must be
    8170 *  square. This function operates only with the psF64 data type. Input and output arguments should not be
    … …  
    172161);
    173162
     163/// @}
     164
    174165#endif

  • trunk/psLib/src/dataManip/psMinimize.h

    r794 r974  
    44/** \file psMinimize.h
    55 *  \brief minimization operations
    6  *  \ingroup MathGroup
     6 *  \ingroup Stats
    77 */
    88
    99/** Functions **************************************************************/
    10 /** \addtogroup MathGroup Math Utilities
     10/** \addtogroup Stats
    1111 *  \{
    1212 */

  • trunk/psLib/src/dataManip/psStats.h

    r889 r974  
    66/** \file psStats.h
    77 *  \brief basic statistical operations
    8  *  \ingroup MathGroup
     8 *  \ingroup Stats
    99 */
    1010#include "psVector.h"
     11
     12/// @addtogroup Stats
     13/// @{
     14
    1115/******************************************************************************
    1216    Statistical functions and data structures.
    … …  
    112116
    113117
     118/// @}
     119
    114120#endif
    115121

  • trunk/psLib/src/dataManip/psVectorFFT.h

    r828 r974  
    33 *  @brief Contains FFT transforms functions
    44 *
     5 *  @ingroup Transform
     6 *
    57 *  @author Robert DeSonia, MHPCC
    68 *
    7  *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
    8  *  @date $Date: 2004-06-02 19:41:57 $
     9 *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     10 *  @date $Date: 2004-06-10 01:58:06 $
    911 *
    1012 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    1618#include "psImage.h"
    1719#include "psVector.h"
     20
     21/// @addtogroup Transform
     22/// @{
    1823
    1924/** Details on FFT implementation (private). */
    … …  
    4247psVector* psVectorPowerSpectrum(psVector* out, const psVector* in);
    4348
     49/// @}
    4450
    4551#endif

  • trunk/psLib/src/fft/psVectorFFT.h

    r828 r974  
    33 *  @brief Contains FFT transforms functions
    44 *
     5 *  @ingroup Transform
     6 *
    57 *  @author Robert DeSonia, MHPCC
    68 *
    7  *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
    8  *  @date $Date: 2004-06-02 19:41:57 $
     9 *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     10 *  @date $Date: 2004-06-10 01:58:06 $
    911 *
    1012 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    1618#include "psImage.h"
    1719#include "psVector.h"
     20
     21/// @addtogroup Transform
     22/// @{
    1823
    1924/** Details on FFT implementation (private). */
    … …  
    4247psVector* psVectorPowerSpectrum(psVector* out, const psVector* in);
    4348
     49/// @}
    4450
    4551#endif

  • trunk/psLib/src/image/psImage.h

    r831 r974  
    66 *  in manupulating images.
    77 *
     8 *  @ingroup Image
     9 *
    810 *  @author Robert DeSonia, MHPCC
    911 *  @author Ross Harman, MHPCC
    1012 *
    11  *  @version $Revision: 1.20 $ $Name: not supported by cvs2svn $
    12  *  @date $Date: 2004-06-02 23:29:14 $
     13 *  @version $Revision: 1.21 $ $Name: not supported by cvs2svn $
     14 *  @date $Date: 2004-06-10 01:58:06 $
    1315 *
    1416 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    2123#include "psType.h"
    2224
    23 /******************************************************************************/
    24 /*  DEFINE STATEMENTS                                                         */
    25 /******************************************************************************/
    26 
    27 // None
    28 
    29 /******************************************************************************/
    30 /*  TYPE DEFINITIONS                                                          */
    31 /******************************************************************************/
     25/// @addtogroup Image
     26/// @{
    3227
    3328/** Basic image data structure.
    … …  
    199194);
    200195
     196/// @}
     197
    201198#endif

  • trunk/psLib/src/image/psImageIO.h

    r817 r974  
    55 *  This file defines the file input/output functions for the psImage structure.
    66 *
     7 *  @ingroup ImageIO
     8 *
    79 *  @author Robert DeSonia, MHPCC
    810 *
    9  *  @version $Revision: 1.1 $ $Name: not supported by cvs2svn $
    10  *  @date $Date: 2004-05-29 01:42:44 $
     11 *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
     12 *  @date $Date: 2004-06-10 01:58:06 $
    1113 *
    1214 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    1618
    1719#include "psImage.h"
     20
     21/// @addtogroup ImageIO
     22/// @{
    1823
    1924/** Read an image or subimage from a FITS file specified by a filename.
    … …  
    7277);
    7378
     79/// @}
     80
    7481#endif

  • trunk/psLib/src/mainpage.dox

    r515 r974  
    1414@section install How to Build from source:
    1515
    16 Before building the IPP from source, it is required that the 'opt' directory 
     16Before building the IPP from source, it is required that the 'opt' directory
    1717tree from cvs be downloaded and built.  The steps are approximately as follows:
    1818<pre>

  • trunk/psLib/src/math/psMatrix.h

    r908 r974  
    1717 *  operate only with the psF64 data type.
    1818 *
     19 *  @ingroup Matrix
     20 *
    1921 *  @author Ross Harman, MHPCC
    20  *   
    21  *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
    22  *  @date $Date: 2004-06-08 01:58:03 $
     22 *
     23 *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     24 *  @date $Date: 2004-06-10 01:58:06 $
    2325 *
    2426 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    2830#define PSMATRIX_H
    2931
    30 /******************************************************************************/
    31 /*  DEFINE STATEMENTS                                                         */
    32 /******************************************************************************/
    33 
    34 // None
    35 
    36 /******************************************************************************/
    37 /*  TYPE DEFINITIONS                                                          */
    38 /******************************************************************************/
    39 
    40 // None
    41 
    42 /*****************************************************************************/
    43 /* FUNCTION PROTOTYPES                                                       */
    44 /*****************************************************************************/
     32/// @addtogroup Matrix
     33/// @{
    4534
    4635/** LU Decomposition of psImage matrix.
    4736 *
    48  *  Performs a LU decomposition on a psImage matrix and returns the LU matrix. If the user specifies NULL for 
     37 *  Performs a LU decomposition on a psImage matrix and returns the LU matrix. If the user specifies NULL for
    4938 *  the outImage or outPerm arguments, then they will be automatically created. The input image must
    5039 *  be square. This function operates only with the psF64 data type. Input and output arguments should not be
    … …  
    7766/** Invert psImage matrix.
    7867 *
    79  *  Inverts a psImage matrix and returns the determinant as an option through the argument list. If the user 
     68 *  Inverts a psImage matrix and returns the determinant as an option through the argument list. If the user
    8069 *  specifies NULL as the outImage argument, then it will automatically be created. The input image must be
    8170 *  square. This function operates only with the psF64 data type. Input and output arguments should not be
    … …  
    172161);
    173162
     163/// @}
     164
    174165#endif

  • trunk/psLib/src/math/psMinimize.h

    r794 r974  
    44/** \file psMinimize.h
    55 *  \brief minimization operations
    6  *  \ingroup MathGroup
     6 *  \ingroup Stats
    77 */
    88
    99/** Functions **************************************************************/
    10 /** \addtogroup MathGroup Math Utilities
     10/** \addtogroup Stats
    1111 *  \{
    1212 */

  • trunk/psLib/src/math/psPolynomial.h

    r889 r974  
    33
    44/** \file psFunctions.h
    5  *  \brief Standard Mathematical Functions.
    6  *  \ingroup MathGroup
     5 *  \brief Standard Mathematical Functions.
     6 *  \ingroup Stats
     7 */
     8
     9/** \addtogroup Stats
     10 *  \{
    711 */
    812
    … …  
    6771
    6872/** Functions **************************************************************/
    69 /** \addtogroup MathGroup Math Utilities
    70  *  \{
    71  */
    7273
    7374/** Constructor */
    … …  
    129130                  );
    130131
    131 /* \} */ // End of MathGroup Functions
    132 
    133132/*****************************************************************************/
    134133
    … …  
    174173}
    175174psDPolynomial4D;
    176 
    177 /** Functions **************************************************************/
    178 /** \addtogroup MathGroup Math Utilities
    179  *  \{
    180  */
    181175
    182176/** Constructor */

  • trunk/psLib/src/math/psSpline.h

    r889 r974  
    33
    44/** \file psFunctions.h
    5  *  \brief Standard Mathematical Functions.
    6  *  \ingroup MathGroup
     5 *  \brief Standard Mathematical Functions.
     6 *  \ingroup Stats
     7 */
     8
     9/** \addtogroup Stats
     10 *  \{
    711 */
    812
    … …  
    6771
    6872/** Functions **************************************************************/
    69 /** \addtogroup MathGroup Math Utilities
    70  *  \{
    71  */
    7273
    7374/** Constructor */
    … …  
    129130                  );
    130131
    131 /* \} */ // End of MathGroup Functions
    132 
    133132/*****************************************************************************/
    134133
    … …  
    174173}
    175174psDPolynomial4D;
    176 
    177 /** Functions **************************************************************/
    178 /** \addtogroup MathGroup Math Utilities
    179  *  \{
    180  */
    181175
    182176/** Constructor */

  • trunk/psLib/src/math/psStats.h

    r889 r974  
    66/** \file psStats.h
    77 *  \brief basic statistical operations
    8  *  \ingroup MathGroup
     8 *  \ingroup Stats
    99 */
    1010#include "psVector.h"
     11
     12/// @addtogroup Stats
     13/// @{
     14
    1115/******************************************************************************
    1216    Statistical functions and data structures.
    … …  
    112116
    113117
     118/// @}
     119
    114120#endif
    115121

  • trunk/psLib/src/mathtypes/psImage.h

    r831 r974  
    66 *  in manupulating images.
    77 *
     8 *  @ingroup Image
     9 *
    810 *  @author Robert DeSonia, MHPCC
    911 *  @author Ross Harman, MHPCC
    1012 *
    11  *  @version $Revision: 1.20 $ $Name: not supported by cvs2svn $
    12  *  @date $Date: 2004-06-02 23:29:14 $
     13 *  @version $Revision: 1.21 $ $Name: not supported by cvs2svn $
     14 *  @date $Date: 2004-06-10 01:58:06 $
    1315 *
    1416 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    2123#include "psType.h"
    2224
    23 /******************************************************************************/
    24 /*  DEFINE STATEMENTS                                                         */
    25 /******************************************************************************/
    26 
    27 // None
    28 
    29 /******************************************************************************/
    30 /*  TYPE DEFINITIONS                                                          */
    31 /******************************************************************************/
     25/// @addtogroup Image
     26/// @{
    3227
    3328/** Basic image data structure.
    … …  
    199194);
    200195
     196/// @}
     197
    201198#endif

  • trunk/psLib/src/mathtypes/psVector.h

    r836 r974  
    66 *  in manupulating vectors.
    77 *
     8 *  @ingroup Vector
     9 *
    810 *  @author Robert DeSonia, MHPCC
    911 *  @author Ross Harman, MHPCC
    1012 *
    11  *  @version $Revision: 1.9 $ $Name: not supported by cvs2svn $
    12  *  @date $Date: 2004-06-03 00:32:32 $
     13 *  @version $Revision: 1.10 $ $Name: not supported by cvs2svn $
     14 *  @date $Date: 2004-06-10 01:58:06 $
    1315 *
    1416 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    1921
    2022#include "psType.h"
     23
     24/// @addtogroup Vector
     25/// @{
    2126
    2227/** An vector to support primitive types.
    … …  
    121126);
    122127
     128/// @}
     129
    123130#endif

  • trunk/psLib/src/pslib.h

    r919 r974  
    88 *  @author Eric Van Alst, MHPCC
    99 *   
    10  *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
    11  *  @date $Date: 2004-06-08 19:08:40 $
     10 *  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
     11 *  @date $Date: 2004-06-10 01:58:06 $
    1212 *
    1313 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    2222
    2323// System Utilities
     24
     25/// @defgroup SysUtils System Utilities
     26/// @{
     27
     28/** @defgroup MemoryManagement Memory Management Utilities
     29 *
     30 *  This is the generic memory management system put inbetween the user's high level code and the OS-level
     31 *  memory allocation routines.  This system adds such features as callback routines for memory error events,
     32 *  tracing capabilities, and reference counting.
     33 *
     34 *  @ingroup SysUtils
     35 */
     36
    2437#include "psMemory.h"
     38
     39/// @defgroup LogTrace Tracing and Logging
     40/// @ingroup SysUtils
    2541#include "psLogMsg.h"
    2642#include "psTrace.h"
     43
     44/// @defgroup ErrorHandling Error Handling
     45/// @ingroup SysUtils
    2746#include "psAbort.h"
    2847#include "psError.h"
     48
    2949#include "psString.h"
    3050
     51/// @}
     52
    3153// Collections
     54/// @defgroup DataContainer Data Containers
     55/// @{
     56
    3257#include "psType.h"
    33 #include "psVector.h"
    34 #include "psImage.h"
    35 #include "psBitSet.h"
    36 #include "psSort.h"
    37 #include "psHash.h"
     58
     59/// @defgroup LinkedList Linked List
     60/// @ingroup DataContainer
    3861#include "psList.h"
    3962
     63/// @defgroup HashTable Hash Table
     64/// @ingroup DataContainer
     65#include "psHash.h"
     66
     67/// @defgroup Vector Vector Container
     68/// @ingroup DataContainer
     69#include "psVector.h"
     70
     71/// @defgroup Image Image Container
     72/// @ingroup DataContainer
     73#include "psImage.h"
     74
     75/// @defgroup BitSet Bit Set
     76/// @ingroup DataContainer
     77#include "psBitSet.h"
     78
     79/// @defgroup Sort Sorting Functions
     80/// @ingroup DataContainer
     81#include "psSort.h"
     82/// @}
     83
    4084// Data Manipulation
     85/// @defgroup DataManip Data Manipulation
     86/// @{
     87
     88/// @defgroup Stats Statistic Functions
     89/// @ingroup DataManip
    4190#include "psStats.h"
     91
     92/// @defgroup Matrix Matrix Operations
     93/// @ingroup DataManip
    4294#include "psMatrix.h"
     95
     96/// @defgroup Transform Fourier Transform
     97/// @ingroup DataManip
    4398#include "psFFT.h"
     99
     100/// @defgroup ImageIO Image File I/O
     101/// @ingroup DataManip
    44102#include "psImageIO.h"
    45103
    46 /******************************************************************************/
    47 /*  DEFINE STATEMENTS                                                         */
    48 /******************************************************************************/
    49 
    50 // None
    51 
    52 /******************************************************************************/
    53 /*  TYPE DEFINITIONS                                                          */
    54 /******************************************************************************/
    55 
    56 // None
    57 
    58 /*****************************************************************************/
    59 /* FUNCTION PROTOTYPES                                                       */
    60 /*****************************************************************************/
     104/// @}
    61105
    62106#endif

  • trunk/psLib/src/sys/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/sys/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/sys/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/sys/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/sys/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/sys/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/sys/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

  • 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

  • trunk/psLib/src/types/psBitSet.h

    r966 r974  
    88 *  string.
    99 *
     10 *  @ingroup BitSet
     11 *
    1012 *  @author Ross Harman, MHPCC
    1113 *
    12  *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
    13  *  @date $Date: 2004-06-10 00:29:57 $
     14 *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
     15 *  @date $Date: 2004-06-10 01:58:06 $
    1416 *
    1517 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    1820#ifndef PSBITSET_H
    1921#define PSBITSET_H
     22
     23/// @addtogroup BitSet
     24/// @{
    2025
    2126/******************************************************************************/
    … …  
    111116);
    112117
     118/// @}
     119
    113120#endif

  • trunk/psLib/src/types/psList.h

    r942 r974  
    44/** @file psList.h
    55 *  @brief Support for doubly linked lists
    6  *  @ingroup DataContainers
    76 *
    87 *  @author Robert Lupton, Princeton University
    98 *  @author Robert Daniel DeSonia, MHPCC
    109 *
    11  *  @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
    12  *  @date $Date: 2004-06-09 02:16:41 $
     10 *  @ingroup LinkedList
     11 *
     12 *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
     13 *  @date $Date: 2004-06-10 01:58:06 $
    1314 *
    1415 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    1819
    1920#include "psVector.h"
     21
     22/** @addtogroup LinkedList
     23 *  @{
     24 */
    2025
    2126/** Special values of index into list
    … …  
    5459}
    5560psList;
    56 
    57 /** @addtogroup DataContainers General Data Container Utilities
    58  *  @{
    59  */
    6061
    6162/** Constructor */
Note: See TracChangeset for help on using the changeset viewer.