Index: /trunk/psLib/src/astro/psCoord.h =================================================================== --- /trunk/psLib/src/astro/psCoord.h (revision 11247) +++ /trunk/psLib/src/astro/psCoord.h (revision 11248) @@ -1,16 +1,13 @@ /** @file psCoord.h * - * @brief Contains basic coordinate transformation definitions and operations + * @brief Basic coordinate transformations * * This file defines the basic types for astronomical coordinate * transformation * - * @ingroup CoordinateTransform - * - * * @author GLG, MHPCC * - * @version $Revision: 1.55 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-12-22 21:19:47 $ + * @version $Revision: 1.56 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:22 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -19,4 +16,7 @@ #ifndef PS_COORD_H #define PS_COORD_H + +/// @addtogroup Astro Astronomy +/// @{ #include "psType.h" @@ -28,7 +28,4 @@ #include "psRegion.h" //#include "psTime.h" - -/// @addtogroup CoordinateTransform -/// @{ /** Euclidiean Coordinate System. @@ -459,4 +456,3 @@ /// @} - #endif // #ifndef PS_COORD_H Index: /trunk/psLib/src/astro/psEarthOrientation.h =================================================================== --- /trunk/psLib/src/astro/psEarthOrientation.h (revision 11247) +++ /trunk/psLib/src/astro/psEarthOrientation.h (revision 11248) @@ -1,14 +1,13 @@ /** @file psEarthOrientation.h * -* @brief Function prototypes for earth orientation calculations -* transformation -* -* @ingroup EarthOrientation -* -* @author Dave Robbins, MHPCC +* @brief earth orientation calculations and transformation +* +* @author Josh Hoblitt, IfA +* @author Ed Pier, IfA +* @author Eugene Magnier, IfA * @author Robert Daniel DeSonia, MHPCC * -* @version $Revision: 1.16 $ $Name: not supported by cvs2svn $ -* @date $Date: 2006-06-14 01:24:34 $ +* @version $Revision: 1.17 $ $Name: not supported by cvs2svn $ +* @date $Date: 2007-01-23 22:47:22 $ * * Copyright 2005 Maui High Performance Computing Center, University of Hawaii @@ -17,4 +16,7 @@ #ifndef PS_EARTH_ORIENTATION #define PS_EARTH_ORIENTATION + +/// @addtogroup Astro Astronomy +/// @{ #include "psCoord.h" @@ -196,3 +198,4 @@ +/// @} #endif // #ifndef PS_EARTH_ORIENTATION Index: /trunk/psLib/src/astro/psSphereOps.h =================================================================== --- /trunk/psLib/src/astro/psSphereOps.h (revision 11247) +++ /trunk/psLib/src/astro/psSphereOps.h (revision 11248) @@ -2,12 +2,10 @@ * * @brief Contains spherical rotation and offset operations - * - * @ingroup CoordinateTransform * * @author Robert DeSonia, MHPCC * @author David Robbins, MHPCC * - * @version $Revision: 1.11 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-02-14 00:09:27 $ + * @version $Revision: 1.12 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:22 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -17,8 +15,8 @@ #define PS_SPHERE_H -/// @addtogroup CoordinateTransform +/// @addtogroup Astro Astronomy /// @{ -#include "psTime.h" +# include "psTime.h" /** Spherical Rotation Definition @@ -111,5 +109,5 @@ * * Combines two rotations to produce a single rotation which is the - * equivalent of applying the first rotation and then the second. The output + * equivalent of applying the ï¬rst rotation and then the second. The output * rotation may be supplied, or will be allocated if NULL. * Index: /trunk/psLib/src/astro/psTime.h =================================================================== --- /trunk/psLib/src/astro/psTime.h (revision 11247) +++ /trunk/psLib/src/astro/psTime.h (revision 11248) @@ -11,6 +11,6 @@ * @author Ross Harman, MHPCC * - * @version $Revision: 1.53 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-11-21 19:23:02 $ + * @version $Revision: 1.54 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:22 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -19,4 +19,7 @@ #ifndef PSTIME_H #define PSTIME_H + +/// @addtogroup Astro Astronomy +/// @{ #include @@ -34,8 +37,4 @@ struct psSphere; - -/// @addtogroup Time -/// @{ - /** Time type. Index: /trunk/psLib/src/db/psDB.h =================================================================== --- /trunk/psLib/src/db/psDB.h (revision 11247) +++ /trunk/psLib/src/db/psDB.h (revision 11248) @@ -1,29 +1,25 @@ -/** @file psDB.h - * - * @brief database types and functions - * - * This file defines the abstract database type and functions that - * perform basic database operations. - * - * @ingroup DataBase - * - * @author Joshua Hoblitt - * - * @version $Revision: 1.33 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-12-13 01:42:51 $ - * - * Copyright 2005 Joshua Hoblitt, University of Hawaii +/* @file psDB.h + * @brief database types and functions + * + * This file defines the abstract database type and functions that + * perform basic database operations. + * + * @author Joshua Hoblitt + * + * @version $Revision: 1.34 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:22 $ + * + * Copyright 2005 Joshua Hoblitt, University of Hawaii */ #ifndef PS_DB_H #define PS_DB_H 1 - #ifdef HAVE_PSDB + +/// @addtogroup FileIO Input/Output +/// @{ #include "psType.h" #include "psMetadata.h" - -/// @addtogroup DataBase -/// @{ /** Database handle @@ -458,8 +454,6 @@ /// @} - #else typedef void psDB; #endif // HAVE_PSDB - #endif // PS_DB_H Index: /trunk/psLib/src/fft/psImageFFT.h =================================================================== --- /trunk/psLib/src/fft/psImageFFT.h (revision 11247) +++ /trunk/psLib/src/fft/psImageFFT.h (revision 11248) @@ -1,14 +1,10 @@ -/** @file psImageFFT.h +/* @file psImageFFT.h + * @brief Contains FFT transform related functions for psImage * - * @brief Contains FFT transform related functions for psImage + * @author Robert DeSonia, MHPCC * - * @ingroup Transform - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-12 19:12:01 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + * @version $Revision: 1.7 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:22 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ @@ -19,5 +15,5 @@ #include "psVectorFFT.h" // for psFFTFlags -/// @addtogroup Transform +/// @addtogroup MathOps Mathematical Operations /// @{ @@ -84,4 +80,3 @@ /// @} - #endif // #ifndef PS_IMAGE_FFT_H Index: /trunk/psLib/src/fft/psVectorFFT.h =================================================================== --- /trunk/psLib/src/fft/psVectorFFT.h (revision 11247) +++ /trunk/psLib/src/fft/psVectorFFT.h (revision 11248) @@ -1,14 +1,10 @@ -/** @file psVectorFFT.h +/* @file psVectorFFT.h + * @brief Contains FFT transform related functions for psVector * - * @brief Contains FFT transform related functions for psVector + * @author Robert DeSonia, MHPCC * - * @ingroup Transform - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.18 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-08 23:40:45 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + * @version $Revision: 1.19 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:22 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ @@ -18,5 +14,5 @@ #include "psVector.h" -/// @addtogroup Transform +/// @addtogroup MathOps Mathematical Operations /// @{ @@ -96,4 +92,3 @@ /// @} - #endif // #ifndef PS_VECTOR_FFT_H Index: /trunk/psLib/src/fits/psFits.h =================================================================== --- /trunk/psLib/src/fits/psFits.h (revision 11247) +++ /trunk/psLib/src/fits/psFits.h (revision 11248) @@ -1,14 +1,10 @@ -/** @file psFits.h - * - * @brief Contains Fits I/O routines - * - * @ingroup FileIO - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.25 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-07-08 03:06:40 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii +/* @file psFits.h + * @brief Contains Fits I/O routines + * + * @author Robert DeSonia, MHPCC + * + * @version $Revision: 1.26 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ @@ -16,6 +12,8 @@ #define PS_FITS_H +/// @addtogroup FileIO Input/Output +/// @{ + #include - #include "psType.h" #include "psArray.h" @@ -23,7 +21,4 @@ #include "psMetadata.h" #include "psImage.h" - -/// @addtogroup FileIO -/// @{ /** FITS HDU type. @@ -203,4 +198,3 @@ /// @} - #endif // #ifndef PS_FITS_H Index: /trunk/psLib/src/fits/psFitsHeader.h =================================================================== --- /trunk/psLib/src/fits/psFitsHeader.h (revision 11247) +++ /trunk/psLib/src/fits/psFitsHeader.h (revision 11248) @@ -1,14 +1,11 @@ -/** @file psFitsHeader.h +/* @file psFitsHeader.h + * @brief Contains Fits header I/O routines * - * @brief Contains Fits header I/O routines + * @author Robert DeSonia, MHPCC * - * @ingroup FileIO + * @version $Revision: 1.10 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.9 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-09-30 02:29:20 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ @@ -16,9 +13,9 @@ #define PS_FITSHEADER_H +/// @addtogroup FileIO Input/Output +/// @{ + #include "psFits.h" #include "psMetadata.h" - -/// @addtogroup FileIO -/// @{ /** Reads the header of the current HDU. @@ -70,4 +67,3 @@ /// @} - #endif // #ifndef PS_FITS_H Index: /trunk/psLib/src/fits/psFitsImage.h =================================================================== --- /trunk/psLib/src/fits/psFitsImage.h (revision 11247) +++ /trunk/psLib/src/fits/psFitsImage.h (revision 11248) @@ -1,14 +1,10 @@ -/** @file psFitsImage.h +/* @file psFitsImage.h + * @brief Contains Fits I/O routines * - * @brief Contains Fits I/O routines + * @author Robert DeSonia, MHPCC * - * @ingroup FileIO - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-08-17 22:15:17 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ @@ -16,6 +12,8 @@ #define PS_FITSIMAGE_H +/// @addtogroup FileIO Input/Output +/// @{ + #include "psFits.h" - #include "psType.h" #include "psArray.h" @@ -23,7 +21,4 @@ #include "psMetadata.h" #include "psImage.h" - -/// @addtogroup FileIO -/// @{ /** Reads an image, given the desired region and z-plane. @@ -89,4 +84,3 @@ /// @} - #endif // #ifndef PS_FITS_H Index: /trunk/psLib/src/fits/psFitsTable.h =================================================================== --- /trunk/psLib/src/fits/psFitsTable.h (revision 11247) +++ /trunk/psLib/src/fits/psFitsTable.h (revision 11248) @@ -1,18 +1,18 @@ -/** @file psFitsTable.h +/* @file psFitsTable.h + * @brief Contains Fits I/O routines * - * @brief Contains Fits I/O routines + * @author EAM, PAP, JH + * @author Robert DeSonia, MHPCC * - * @ingroup FileIO - * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-06-13 22:28:02 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ #ifndef PS_FITSTABLE_H #define PS_FITSTABLE_H + +/// @addtogroup FileIO Input/Output +/// @{ #include "psFits.h" @@ -23,7 +23,4 @@ #include "psMetadata.h" #include "psImage.h" - -/// @addtogroup FileIO -/// @{ /** Reads a table row. The current HDU type must be either @@ -117,4 +114,3 @@ /// @} - #endif // #ifndef PS_FITS_H Index: /trunk/psLib/src/imageops/psImageBackground.h =================================================================== --- /trunk/psLib/src/imageops/psImageBackground.h (revision 11247) +++ /trunk/psLib/src/imageops/psImageBackground.h (revision 11248) @@ -1,4 +1,18 @@ +/** @file psImageUnbin.h + * + * @brief Functions to determine the image background + * + * @author EAM, IfA + * + * $Revision: 1.4 $ $Name: not supported by cvs2svn $ + * $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 IfA, University of Hawaii + */ + #ifndef PS_IMAGE_BACKGROUND_H #define PS_IMAGE_BACKGROUND_H + +/// @addtogroup ImageOps Image Operations +/// @{ #include "psStats.h" @@ -14,3 +28,4 @@ ); +/// @} #endif // #ifndef PS_IMAGE_BACKGROUND_H Index: /trunk/psLib/src/imageops/psImageConvolve.h =================================================================== --- /trunk/psLib/src/imageops/psImageConvolve.h (revision 11247) +++ /trunk/psLib/src/imageops/psImageConvolve.h (revision 11248) @@ -1,18 +1,18 @@ -/** @file psImageConvolve.h +/* @file psImageConvolve.h * - * @brief image convolution functionality + * @brief image convolution functionality * - * @ingroup Transform + * @author Robert DeSonia, MHPCC * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.14 $ $Name: not supported by cvs2svn $ - * @date $Date: 2007-01-19 04:30:33 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + * @version $Revision: 1.15 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ #ifndef PS_IMAGE_CONVOLVE_H #define PS_IMAGE_CONVOLVE_H + +/// @addtogroup ImageOps Image Operations +/// @{ #include "psImage.h" @@ -158,4 +158,4 @@ ); - +/// @} #endif // #ifndef PS_IMAGE_CONVOLVE_H Index: /trunk/psLib/src/imageops/psImageGeomManip.h =================================================================== --- /trunk/psLib/src/imageops/psImageGeomManip.h (revision 11247) +++ /trunk/psLib/src/imageops/psImageGeomManip.h (revision 11248) @@ -1,18 +1,18 @@ -/** @file psImageGeomManip.h +/* @file psImageGeomManip.h * - * @brief Contains basic image geometry manipulation operations, as - * specified in the PSLIB SDRS sections "Image Geometry Manipulations". + * @brief Contains basic image geometry manipulation operations, as + * specified in the PSLIB SDRS sections "Image Geometry Manipulations". * - * @ingroup Image + * @author Robert DeSonia, MHPCC * - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.17 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-11-09 20:20:27 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + * @version $Revision: 1.18 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ #ifndef PS_IMAGE_GEOM_MANIP_H #define PS_IMAGE_GEOM_MANIP_H + +/// @addtogroup ImageOps Image Operations +/// @{ #include "psImage.h" @@ -20,7 +20,4 @@ #include "psStats.h" #include "psPixels.h" - -/// @addtogroup Image -/// @{ /** Rebin image to new scale. @@ -185,6 +182,6 @@ psRegion region, ///< the size of the transformed image const psPixels* pixels, /**< if not NULL, consists of psPixelCoords and specifies - * which pixels in output image shall be transformed; - * otherwise, entire image generated*/ + * which pixels in output image shall be transformed; + * otherwise, entire image generated*/ psImageInterpolateMode mode, ///< the interpolation scheme to be used double exposedValue ///< Exposed value to which non-corresponding pixels are set @@ -198,3 +195,4 @@ ); +/// @} #endif // #ifndef PS_IMAGE_GEOM_MANIP_H Index: /trunk/psLib/src/imageops/psImageMaskOps.h =================================================================== --- /trunk/psLib/src/imageops/psImageMaskOps.h (revision 11247) +++ /trunk/psLib/src/imageops/psImageMaskOps.h (revision 11248) @@ -1,18 +1,20 @@ -/** @file psImageMaskOps.h +/* @file psImageMaskOps.h * - * @brief Contains basic image pixel manipulation operations, as - * specified in the PSLIB SDRS sections "Mask Operations" + * @brief Contains basic image pixel manipulation operations, as + * specified in the PSLIB SDRS sections "Mask Operations" * - * @ingroup Image + * @author David Robbins, MHPCC * - * @author David Robbins, MHPCC + * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ * - * @version $Revision: 1.1 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-10-10 20:12:13 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ + #ifndef PS_IMAGE_MASK_OPS_H #define PS_IMAGE_MASK_OPS_H + +/// @addtogroup ImageOps Image Operations +/// @{ #include "psImage.h" @@ -20,7 +22,4 @@ #include "psStats.h" #include "psPixels.h" - -/// @addtogroup Image -/// @{ /** Sets the bits inside the region, ignoring pixels outside. @@ -95,3 +94,4 @@ ); +/// @} #endif // #ifndef PS_MASK_OPS_H Index: /trunk/psLib/src/imageops/psImagePixelExtract.h =================================================================== --- /trunk/psLib/src/imageops/psImagePixelExtract.h (revision 11247) +++ /trunk/psLib/src/imageops/psImagePixelExtract.h (revision 11248) @@ -1,19 +1,19 @@ -/** @file psImagePixelExtract.h -* -* @brief Contains basic image extraction operations, as specified in the -* PSLIB SDRS sections "Image Pixel Extractions". -* -* @ingroup Image -* -* @author Robert DeSonia, MHPCC -* -* @version $Revision: 1.9 $ $Name: not supported by cvs2svn $ -* @date $Date: 2006-02-02 04:41:42 $ -* -* Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii -*/ +/* @file psImagePixelExtract.h + * + * @brief Basic image extraction operations + * + * @author Robert DeSonia, MHPCC + * + * @version $Revision: 1.10 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + */ #ifndef PSIMAGE_PIXEL_EXTRACT_H #define PSIMAGE_PIXEL_EXTRACT_H + +/// @addtogroup ImageOps Image Operations +/// @{ #include "psImage.h" @@ -21,7 +21,4 @@ #include "psStats.h" #include "psPixels.h" - -/// @addtogroup Image -/// @{ /* Cut direction flag. Used with psImageCut function. @@ -146,4 +143,3 @@ /// @} - #endif // #ifndef PSIMAGE_PIXEL_EXTRACT_H Index: /trunk/psLib/src/imageops/psImagePixelManip.h =================================================================== --- /trunk/psLib/src/imageops/psImagePixelManip.h (revision 11247) +++ /trunk/psLib/src/imageops/psImagePixelManip.h (revision 11248) @@ -1,18 +1,19 @@ -/** @file psImagePixelManip.h +/* @file psImagePixelManip.h * - * @brief Contains basic image pixel manipulation operations, as - * specified in the PSLIB SDRS sections "Image Pixel Manipulations" + * @brief Basic image pixel manipulation operations * - * @ingroup Image + * @author Robert DeSonia, MHPCC * - * @author Robert DeSonia, MHPCC + * @version $Revision: 1.16 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ * - * @version $Revision: 1.15 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-01-28 01:12:11 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ + #ifndef PS_IMAGE_PIXEL_MANIP_H #define PS_IMAGE_PIXEL_MANIP_H + +/// @addtogroup ImageOps Image Operations +/// @{ #include "psImage.h" @@ -20,7 +21,4 @@ #include "psStats.h" #include "psPixels.h" - -/// @addtogroup Image -/// @{ /** Clip image values outside of range to given values @@ -88,3 +86,4 @@ ); +/// @} #endif // #ifndef PS_IMAGE_PIXEL_MANIP_H Index: /trunk/psLib/src/imageops/psImageStats.h =================================================================== --- /trunk/psLib/src/imageops/psImageStats.h (revision 11247) +++ /trunk/psLib/src/imageops/psImageStats.h (revision 11248) @@ -1,19 +1,22 @@ -/** @file psImageStats.h -* \brief Routines for calculating statistics on images. -* @ingroup ImageStats -* -* This file will hold the prototypes for procedures which calculate -* statistic on images, histograms on images, and fit/evaluate Chebyshev -* polynomials to images. -* -* @author GLG, MHPCC -* -* @version $Revision: 1.29 $ $Name: not supported by cvs2svn $ -* @date $Date: 2006-12-08 11:37:31 $ -* -* Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii -*/ +/* @file psImageStats.h + * + * @brief Routines for calculating statistics on images. + * + * This file will hold the prototypes for procedures which calculate + * statistic on images, histograms on images, and fit/evaluate Chebyshev + * polynomials to images. + * + * @author GLG, MHPCC + * + * @version $Revision: 1.30 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + */ + #ifndef PS_IMAGE_STATS_H #define PS_IMAGE_STATS_H + +/// @addtogroup ImageOps Image Operations +/// @{ #include "psType.h" @@ -24,7 +27,4 @@ #include "psPolynomial.h" #include "psRegion.h" - -/// @addtogroup ImageStats -/// @{ /** This routine must determine the various statistics for the image. @@ -101,4 +101,3 @@ /// @} - #endif // #ifndef PS_IMAGE_STATS_H Index: /trunk/psLib/src/imageops/psImageStructManip.h =================================================================== --- /trunk/psLib/src/imageops/psImageStructManip.h (revision 11247) +++ /trunk/psLib/src/imageops/psImageStructManip.h (revision 11248) @@ -1,14 +1,10 @@ /** @file psImageStructManip.h * -* @brief Contains basic image structure manipulation operations, as specified -* in the PSLIB SDRS sections "Image Structure Manipulation". -* -* @ingroup Image +* @brief basic image structure manipulation operations * * @author Robert DeSonia, MHPCC * -* @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ -* @date $Date: 2006-04-17 22:00:03 $ -* +* @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ +* @date $Date: 2007-01-23 22:47:23 $ * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ @@ -17,24 +13,22 @@ #define PSIMAGE_STRUCT_MANIP_H +/// @addtogroup ImageOps Image Operations +/// @{ + #include "psImage.h" #include "psRegion.h" -/// @addtogroup Image -/// @{ - /** Create a subimage of the specified area. * - * Define a subimage of the specified area of the given image. This function - * must raise an error if the requested subset area lies outside of the - * parent image and return NULL. The argument image is the parent image, - * region.x0, region.y0 specify the starting pixel of the subraster, and - * region.x1,region.y1 specify the extent of the desired subraster. Note - * that the row and column of this “upper right-hand corner” are NOT included - * in the region. In the event that x1 or y1 are negative, they shall be - * interpreted as being relative to the size of the parent image in that - * dimension. The entire subraster must be contained within the raster of the - * parent image. Note that the refCounter for the parent should be - * incremented. This function must be defined for the following types: psU8, - * psU16, psS8, psS16, psF32, psF64, psC32, psC64. + * Define a subimage of the specified area of the given image. This function must raise an + * error if the requested subset area lies outside of the parent image and return NULL. The + * argument image is the parent image, region.x0, region.y0 specify the starting pixel of the + * subraster, and region.x1,region.y1 specify the extent of the desired subraster. Note that + * the row and column of this upper right-hand corner NOT included in the region. In the event + * that x1 or y1 are negative, they shall be interpreted as being relative to the size of the + * parent image in that dimension. The entire subraster must be contained within the raster of + * the parent image. Note that the refCounter for the parent should be incremented. This + * function must be defined for the following types: psU8, psU16, psS8, psS16, psF32, psF64, + * psC32, psC64. * * @return psImage* : Pointer to psImage. @@ -60,17 +54,16 @@ /** Trim an image * - * Trim the specified image in-place, which involves shuffling the pixels - * around in memory. The pixels in the region [col0:col1,row0:row1] shall consist - * the output image. The column col1 and row row1 are NOT included in the range. - * In the event that x1 or y1 are non-positive, they shall be interpreted as - * being relative to the size of the parent image in that dimension. + * Trim the specified image in-place, which involves shuffling the pixels around in memory. + * The pixels in the region [col0:col1,row0:row1] shall consist the output image. The column + * col1 and row row1 are NOT included in the range. In the event that x1 or y1 are + * non-positive, they shall be interpreted as being relative to the size of the parent image + * in that dimension. * - * If the entire specified subimage is not contained within the parent - * image, an error results and the return value will be NULL. + * If the entire specified subimage is not contained within the parent image, an error results + * and the return value will be NULL. * - * N.B. If the input psImage is a child of another psImage, no pixel data - * will be trimmed, rather it equivalent to calling psImageSubset. If the input - * psImage is, however, a parent psImage, any children will be obliterated, - * i.e., freed from memory. + * N.B. If the input psImage is a child of another psImage, no pixel data will be trimmed, + * rather it equivalent to calling psImageSubset. If the input psImage is, however, a parent + * psImage, any children will be obliterated, i.e., freed from memory. * * @return psImage* trimmed image result @@ -82,4 +75,3 @@ /// @} - #endif // #ifndef PSIMAGE_STRUCT_MANIP_H Index: /trunk/psLib/src/imageops/psImageUnbin.h =================================================================== --- /trunk/psLib/src/imageops/psImageUnbin.h (revision 11247) +++ /trunk/psLib/src/imageops/psImageUnbin.h (revision 11248) @@ -1,4 +1,19 @@ +/** @file psImageUnbin.h + * + * @brief Functions to unbin images + * + * @author EAM, IfA + * @author Robert DeSonia, MHPCC + * + * $Revision: 1.3 $ $Name: not supported by cvs2svn $ + * $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + */ + #ifndef PS_IMAGE_UNBIN_H #define PS_IMAGE_UNBIN_H + +/// @addtogroup ImageOps Image Operations +/// @{ #include "psImage.h" @@ -16,3 +31,4 @@ ); +/// @} #endif Index: /trunk/psLib/src/jpeg/psImageJpeg.h =================================================================== --- /trunk/psLib/src/jpeg/psImageJpeg.h (revision 11247) +++ /trunk/psLib/src/jpeg/psImageJpeg.h (revision 11248) @@ -1,9 +1,15 @@ -/** @file psImageJpeg.h - * - * the functions to generate JPEG images from psImage +/* @file psImageJpeg.h + * @brief functions to generate JPEG images from psImage + * + * @author EAM + * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ */ #ifndef PS_IMAGE_JPEG_H #define PS_IMAGE_JPEG_H + +/// @addtogroup FileIO Input/Output +/// @{ #include "psImage.h" @@ -37,3 +43,4 @@ ); +/// @} #endif /* PS_IMAGE_JPEG_H */ Index: /trunk/psLib/src/math/psBinaryOp.h =================================================================== --- /trunk/psLib/src/math/psBinaryOp.h (revision 11247) +++ /trunk/psLib/src/math/psBinaryOp.h (revision 11248) @@ -1,37 +1,35 @@ -/** @file psBinaryOp.h +/* @file psBinaryOp.h * - * @brief Provides binary functions for simple matrix and vector element operations. Functions - * include: + * @brief Provides binary functions for simple matrix and vector element operations. + * + * Functions include: + * Addition (+) + * Subtraction (-) + * Multiplication (*) + * Division (/) + * Power (^) + * Minimum (min) + * Maximum (max) + * Absolute value (abs) + * Exponent (exp) + * Natural Log (ln) + * Power of 10 (ten) + * Log (log) + * Sine (sin or dsin) + * Cosine (cos or dcos) + * Tangent (tan or dtan) + * Arcsine (asin or dasin) + * Arccosine (acos or dacos) + * Arctan (atan or datan) * - * Addition (+) - * Subtraction (-) - * Multiplication (*) - * Division (/) - * Power (^) - * Minimum (min) - * Maximum (max) - * Absolute value (abs) - * Exponent (exp) - * Natural Log (ln) - * Power of 10 (ten) - * Log (log) - * Sine (sin or dsin) - * Cosine (cos or dcos) - * Tangent (tan or dtan) - * Arcsine (asin or dasin) - * Arccosine (acos or dacos) - * Arctan (atan or datan) + * Currently only vector-vector and image-image binary operations are supported. * - * Currently only vector-vector and image-image binary operations are supported. + * @author Ross Harman, MHPCC + * @author Robert DeSonia, MHPCC * - * @ingroup MatrixArithmetic + * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ * - * @author Ross Harman, MHPCC - * @author Robert DeSonia, MHPCC - * - * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-12 19:12:01 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ @@ -39,5 +37,5 @@ #define PSBINARY_OP_H -/// @addtogroup MatrixArithmetic +/// @addtogroup MathOps Mathematical Operations /// @{ @@ -63,4 +61,3 @@ /// @} - #endif // #ifndef PSBINARY_OP_H Index: /trunk/psLib/src/math/psClip.h =================================================================== --- /trunk/psLib/src/math/psClip.h (revision 11247) +++ /trunk/psLib/src/math/psClip.h (revision 11248) @@ -1,4 +1,15 @@ +/* @file psClip.h + * @brief vector clipping functions + * + * $Revision: 1.2 $ $Name: not supported by cvs2svn $ + * $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + */ + #ifndef PS_CLIP_H #define PS_CLIP_H + +/// @addtogroup MathOps Mathematical Operations +/// @{ /// Parameters for clipping @@ -26,3 +37,4 @@ ); +/// @} #endif Index: /trunk/psLib/src/math/psCompare.h =================================================================== --- /trunk/psLib/src/math/psCompare.h (revision 11247) +++ /trunk/psLib/src/math/psCompare.h (revision 11248) @@ -1,13 +1,10 @@ -/** @file psCompare.h - * @brief Comparison functions for sorting routines - * - * @author Robert Daniel DeSonia, MHPCC - * - * @ingroup Compare - * - * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-06-23 03:50:29 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii +/* @file psCompare.h + * @brief Comparison functions for sorting routines + * + * @author Robert Daniel DeSonia, MHPCC + * + * @version $Revision: 1.9 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ @@ -15,9 +12,8 @@ #define PS_COMPARE_H +/// @addtogroup MathOps Mathematical Operations +/// @{ + #include "psType.h" - -/** @addtogroup Compare -* @{ -*/ /** A comparison function for sorting elements that are pointers to data, @@ -503,6 +499,4 @@ ); - /// @} - #endif // #ifndef PS_COMPARE_H Index: /trunk/psLib/src/math/psConstants.h =================================================================== --- /trunk/psLib/src/math/psConstants.h (revision 11247) +++ /trunk/psLib/src/math/psConstants.h (revision 11248) @@ -1,26 +1,31 @@ -/** @file psConstants.h +/* @file psConstants.h * - * This file will hold definitions of various constants as well as common - * macros used throughout psLib. + * @brief Definitions of various constants and common macros * - * @author GLG, MHPCC + * @author GLG, MHPCC * - * @version $Revision: 1.94 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-10-17 01:34:45 $ + * @version $Revision: 1.95 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii * - * XXX: Add parenthesis around all arguments so that these macros can be - * called with complex expressions. + * XXX: Add parenthesis around all arguments so that these macros can be + * called with complex expressions. * - * XXX: All functions which use the PS_ASSERT macros must be scrutinized so - * that we ensure that an argument which is expected to be output is - * psFree'ed before reurning NULL. + * XXX: All functions which use the PS_ASSERT macros must be scrutinized so + * that we ensure that an argument which is expected to be output is + * psFree'ed before reurning NULL. * - * XXX: The macros have a name similar to PS_CHECK_CONDITION() and generally - * throw a psError if the CONDITION is true. However, some throw the error - * if the CONDITION is false. This should be consistant. + * XXX: The macros have a name similar to PS_CHECK_CONDITION() and generally + * throw a psError if the CONDITION is true. However, some throw the error + * if the CONDITION is false. This should be consistant. * */ + +#ifndef PS_CONSTANTS_H +#define PS_CONSTANTS_H + +/// @addtogroup MathOps Mathematical Operations +/// @{ #include // for M_PI @@ -62,2 +67,4 @@ #define PS_NOT_U16(A)(USHORT_MAX-(A)) // Perform bitwaise NOT on A which is of type U16 +/// @} +#endif Index: /trunk/psLib/src/math/psEllipse.h =================================================================== --- /trunk/psLib/src/math/psEllipse.h (revision 11247) +++ /trunk/psLib/src/math/psEllipse.h (revision 11248) @@ -1,10 +1,15 @@ -/** @file psEllipse.h +/* @file psEllipse.h + * @brief functions to manipulate sparse matrices equations * - * functions to manipulate sparse matrices equations - * + * $Revision: 1.3 $ $Name: not supported by cvs2svn $ + * $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ #ifndef PS_ELLIPSE_H #define PS_ELLIPSE_H + +/// @addtogroup MathOps Mathematical Operations +/// @{ // strucures to define elliptical shape parameters @@ -39,3 +44,4 @@ psEllipseAxes psEllipseShapeToAxes(psEllipseShape shape, double maxAR); +/// @} #endif Index: /trunk/psLib/src/math/psHistogram.h =================================================================== --- /trunk/psLib/src/math/psHistogram.h (revision 11247) +++ /trunk/psLib/src/math/psHistogram.h (revision 11248) @@ -1,15 +1,14 @@ -/** @file psHistogram.h - * \brief basic histogram functions - * @ingroup Math +/* @file psHistogram.h + * @brief basic histogram functions * - * This file holds the definition of the histogram data structures. It also contains - * prototypes for procedures which operate on those data structures. + * This file holds the definition of the histogram data structures. It also contains + * prototypes for procedures which operate on those data structures. * - * @author GLG, MHPCC + * @author GLG, MHPCC * - * @version $Revision: 1.1 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-12-08 11:38:54 $ + * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ * - * Copyright 2004-2005 IfA, University of Hawaii + * Copyright 2004-2005 IfA, University of Hawaii */ @@ -17,7 +16,5 @@ #define PS_HISTOGRAM_H -// #include "psVector.h" - -/// @addtogroup Math +/// @addtogroup MathOps Mathematical Operations /// @{ @@ -95,4 +92,3 @@ /// @} - #endif // #ifndef PS_HISTOGRAM_H Index: /trunk/psLib/src/math/psMD5.h =================================================================== --- /trunk/psLib/src/math/psMD5.h (revision 11247) +++ /trunk/psLib/src/math/psMD5.h (revision 11248) @@ -1,4 +1,15 @@ +/* @file psMD5.h + * @brief support for MD5 hashes + * + * $Revision: 1.2 $ $Name: not supported by cvs2svn $ + * $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + */ + #ifndef PS_MD5_H #define PS_MD5_h + +/// @addtogroup MathOps Mathematical Operations +/// @{ #include "psVector.h" @@ -28,4 +39,4 @@ ); - +/// @} #endif Index: /trunk/psLib/src/math/psMathUtils.h =================================================================== --- /trunk/psLib/src/math/psMathUtils.h (revision 11247) +++ /trunk/psLib/src/math/psMathUtils.h (revision 11248) @@ -1,18 +1,19 @@ -/** @file psMathUtils.h - * @brief Standard Mathematical Functions. - * @ingroup GROUP00 +/* @file psMathUtils.h + * @brief Standard Mathematical Functions. * - * This file contains standard math rotines. + * This file contains standard math rotines. * - * @author GLG, MHPCC + * @author GLG, MHPCC * - * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-05-18 01:20:51 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ #ifndef PS_MATHUTILS_H #define PS_MATHUTILS_H + +/// @addtogroup MathOps Mathematical Operations +/// @{ #include @@ -23,8 +24,4 @@ #include "psScalar.h" #include "psPolynomial.h" - -/** \addtogroup GROUP00 - * \{ - */ /** Performs a binary disection on a monotonically non-decreasing vector. @@ -55,6 +52,4 @@ psF64 outHigh); -/** \} */ // End of MathGroup Functions - +/// @} #endif // #ifndef PS_MATHUTILS_H - Index: /trunk/psLib/src/math/psMatrix.h =================================================================== --- /trunk/psLib/src/math/psMatrix.h (revision 11247) +++ /trunk/psLib/src/math/psMatrix.h (revision 11248) @@ -1,28 +1,25 @@ -/** @file psMatrix.h +/* @file psMatrix.h * - * @brief Provides functions for linear algebra operations on psImages and psVectors. + * @brief Provides functions for linear algebra operations on psImages and psVectors. * - * Functions are provided to: - * Transpose a psImage - * Compute LUD - * Solve LUD - * Matrix inversion - * Calculate determinant - * Matrix multiplication - * Calculate Eigenvectors - * Convert matrix to vector - * Convert vector to matrix + * Functions are provided to: + * Transpose a psImage + * Compute LUD + * Solve LUD + * Matrix inversion + * Calculate determinant + * Matrix multiplication + * Calculate Eigenvectors + * Convert matrix to vector + * Convert vector to matrix * - * These functions treat psImages as if they were matrices, therefore there is no psMatrix. These functions - * operate only with the psF64 data type. + * These functions treat psImages as if they were matrices, therefore there is no psMatrix. These functions + * operate only with the psF64 data type. * - * @ingroup Matrix + * @author Ross Harman, MHPCC * - * @author Ross Harman, MHPCC - * - * @version $Revision: 1.25 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-12-01 21:48:47 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + * @version $Revision: 1.26 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ @@ -30,5 +27,5 @@ #define PSMATRIX_H -/// @addtogroup Matrix +/// @addtogroup MathOps Mathematical Operations /// @{ @@ -183,4 +180,3 @@ /// @} - #endif // #ifndef PSMATRIX_H Index: /trunk/psLib/src/math/psMinimizeLMM.h =================================================================== --- /trunk/psLib/src/math/psMinimizeLMM.h (revision 11247) +++ /trunk/psLib/src/math/psMinimizeLMM.h (revision 11248) @@ -1,16 +1,13 @@ -/** @file psMinimizeLMM.c - * \brief basic minimization functions - * @ingroup Math +/* @file psMinimizeLMM.c + * @brief basic minimization functions * - * This file will contain function prototypes for various Levenberg-Marquadt - * minimization routines. + * This file will contain function prototypes for various Levenberg-Marquadt + * minimization routines. * - * @author GLG, MHPCC + * @author GLG, MHPCC * - * @version $Revision: 1.7 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-11-29 02:17:15 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - * + * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ @@ -18,11 +15,6 @@ #define PS_MINIMIZE_LMM_H -/** \file psMinimizeLMM.h - * \brief minimization operations - * \ingroup Stats - */ -/** \addtogroup Stats - * \{ - */ +/// @addtogroup MathOps Mathematical Operations +/// @{ #include "psVector.h" @@ -176,6 +168,4 @@ ); -/* \} */// End of MathGroup Functions - +/// @} #endif // #ifndef PS_MINIMIZE_LMM_H - Index: /trunk/psLib/src/math/psMinimizePolyFit.h =================================================================== --- /trunk/psLib/src/math/psMinimizePolyFit.h (revision 11247) +++ /trunk/psLib/src/math/psMinimizePolyFit.h (revision 11248) @@ -1,17 +1,13 @@ -/** @file psMinimizePolyFit.c - * \brief basic minimization functions - * @ingroup Math +/* @file psMinimizePolyFit.c + * @brief basic minimization functions * - * This file will contain function prototypes for various - * 1-D polynomial fitting routines. + * This file will contain function prototypes for various + * 1-D polynomial fitting routines. * - * @author GLG, MHPCC + * @author GLG, MHPCC * - * XXX: Must Doxygenate. - * - * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-12-29 04:38:42 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii * */ @@ -20,11 +16,6 @@ #define PS_MINIMIZE_POLYFIT_H -/** \file psMinimizePolyFit.h - * \brief minimization operations - * \ingroup Stats - */ -/** \addtogroup Stats - * \{ - */ +/// @addtogroup MathOps Mathematical Operations +/// @{ #include "psVector.h" @@ -143,6 +134,4 @@ ); -/* \} */// End of MathGroup Functions - +/// @} #endif // #ifndef PS_MINIMIZE_POLYFIT_H - Index: /trunk/psLib/src/math/psMinimizePowell.h =================================================================== --- /trunk/psLib/src/math/psMinimizePowell.h (revision 11247) +++ /trunk/psLib/src/math/psMinimizePowell.h (revision 11248) @@ -1,15 +1,14 @@ -/** @file psMinimizePowell.c - * \brief basic minimization functions - * @ingroup Math +/* @file psMinimizePowell.c + * @brief basic minimization functions * - * This file will contain function prototypes for various Powell - * chi-squared minimization routines. + * This file will contain function prototypes for various Powell + * chi-squared minimization routines. * - * @author GLG, MHPCC + * @author GLG, MHPCC * - * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-11-29 02:33:54 $ + * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii * */ @@ -18,11 +17,6 @@ #define PS_MINIMIZE_POWELL_H -/** \file psMinimizePowell.h - * \brief minimization operations - * \ingroup Stats - */ -/** \addtogroup Stats - * \{ - */ +/// @addtogroup MathOps Mathematical Operations +/// @{ #include "psMinimizeLMM.h" @@ -88,6 +82,4 @@ ); -/* \} */// End of MathGroup Functions - +/// @} #endif // #ifndef PS_MINIMIZE_POWELL_H - Index: /trunk/psLib/src/math/psPolynomial.h =================================================================== --- /trunk/psLib/src/math/psPolynomial.h (revision 11247) +++ /trunk/psLib/src/math/psPolynomial.h (revision 11248) @@ -1,22 +1,22 @@ -/** @file psPolynomial.h - * @brief Standard Mathematical Functions. - * @ingroup Stats - * - * This file will hold the prototypes for procedures which allocate, free, - * and evaluate various polynomials. Those polynomial structures are also - * defined here. - * - * @ingroup Stats - * - * @author GLG, MHPCC - * - * @version $Revision: 1.66 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-12-29 04:38:42 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii +/* @file psPolynomial.h + * @brief Standard Mathematical Functions. + * + * This file will hold the prototypes for procedures which allocate, free, + * and evaluate various polynomials. Those polynomial structures are also + * defined here. + * + * @author GLG, MHPCC + * + * @version $Revision: 1.67 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ #ifndef PS_POLYNOMIAL_H #define PS_POLYNOMIAL_H + +/// @addtogroup MathOps Mathematical Operations +/// @{ #include @@ -27,8 +27,4 @@ #include "psVector.h" #include "psScalar.h" - -/** \addtogroup Stats - * \{ - */ /** Evaluate a non-normalized Gaussian with the given mean and sigma at the @@ -351,6 +347,4 @@ }\ -/** \} */ // End of MathGroup Functions - +/// @} #endif // #ifndef PS_POLYNOMIAL_H - Index: /trunk/psLib/src/math/psPolynomialUtils.h =================================================================== --- /trunk/psLib/src/math/psPolynomialUtils.h (revision 11247) +++ /trunk/psLib/src/math/psPolynomialUtils.h (revision 11248) @@ -1,9 +1,15 @@ -/** @file psPolynomialUtils.h +/* @file psPolynomialUtils.h + * @brief extra psPolynomial-related functions * - * extra psPolynomial-related functions + * $Revision: 1.5 $ $Name: not supported by cvs2svn $ + * $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ #ifndef PS_POLYNOMIAL_UTILS_H #define PS_POLYNOMIAL_UTILS_H + +/// @addtogroup MathOps Mathematical Operations +/// @{ #include "psVector.h" @@ -38,3 +44,4 @@ psPolynomial2D *psPolynomial2D_dY (psPolynomial2D *out, psPolynomial2D *poly); +/// @} #endif /* PS_POLY_UTILS_H */ Index: /trunk/psLib/src/math/psRandom.h =================================================================== --- /trunk/psLib/src/math/psRandom.h (revision 11247) +++ /trunk/psLib/src/math/psRandom.h (revision 11248) @@ -1,21 +1,21 @@ -/** @file psRandom.h -* \brief Random Number Generators -* \ingroup Math -* -* This file will hold the prototypes for procedures which allocate, free, -* and evaluate random number Generators. -* -* @ingroup Math -* -* @author GLG, MHPCC -* -* @version $Revision: 1.7 $ $Name: not supported by cvs2svn $ -* @date $Date: 2005-08-23 23:23:05 $ -* -* Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii -*/ +/* @file psRandom.h + * @brief Random Number Generators + * + * This file will hold the prototypes for procedures which allocate, free, + * and evaluate random number Generators. + * + * @author GLG, MHPCC + * + * @version $Revision: 1.8 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + */ #ifndef PS_RANDOM_H #define PS_RANDOM_H + +/// @addtogroup MathOps Mathematical Operations +/// @{ #include @@ -28,8 +28,4 @@ #include #include - -/** \addtogroup Math - * \{ - */ /** Enumeration containing a flag for psRandom types. */ @@ -109,5 +105,4 @@ ); -/* \} */// End of MathGroup Functions - +/// @} #endif // #ifndef PS_RANDOM_H Index: /trunk/psLib/src/math/psRegion.h =================================================================== --- /trunk/psLib/src/math/psRegion.h (revision 11247) +++ /trunk/psLib/src/math/psRegion.h (revision 11248) @@ -1,4 +1,15 @@ +/* @file psRegion.h + * @brief image regions and related functions + * + * $Revision: 1.8 $ $Name: not supported by cvs2svn $ + * $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + */ + #ifndef PS_REGION_H #define PS_REGION_H + +/// @addtogroup MathOps Mathematical Operations +/// @{ #include "psString.h" @@ -89,3 +100,4 @@ ); +/// @} #endif Index: /trunk/psLib/src/math/psRegionForImage.h =================================================================== --- /trunk/psLib/src/math/psRegionForImage.h (revision 11247) +++ /trunk/psLib/src/math/psRegionForImage.h (revision 11248) @@ -1,5 +1,15 @@ +/* @file psRegionForImage.h + * @brief regions definitions based on images + * + * $Revision: 1.3 $ $Name: not supported by cvs2svn $ + * $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + */ + #ifndef PS_REGION_FOR_IMAGE_H #define PS_REGION_FOR_IMAGE_H +/// @addtogroup MathOps Mathematical Operations +/// @{ /** Sets an actual region based on image parameters. @@ -22,5 +32,4 @@ ); - - +/// @} #endif Index: /trunk/psLib/src/math/psSparse.h =================================================================== --- /trunk/psLib/src/math/psSparse.h (revision 11247) +++ /trunk/psLib/src/math/psSparse.h (revision 11248) @@ -1,10 +1,15 @@ -/** @file psSparse.h +/* @file psSparse.h + * @brief functions to manipulate sparse matrices equations * - * functions to manipulate sparse matrices equations - * + * $Revision: 1.8 $ $Name: not supported by cvs2svn $ + * $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 IfA, University of Hawaii */ #ifndef PS_SPARSE_H #define PS_SPARSE_H + +/// @addtogroup MathOps Mathematical Operations +/// @{ // constraints to limit the range of the matrix equation solution @@ -102,3 +107,4 @@ bool psSparseBorderSolve(psVector **xFit, psVector **yFit, psSparseConstraint constraint, psSparseBorder *border, int Niter); +/// @} #endif /* PS_SPARSE_H */ Index: /trunk/psLib/src/math/psSpline.h =================================================================== --- /trunk/psLib/src/math/psSpline.h (revision 11247) +++ /trunk/psLib/src/math/psSpline.h (revision 11248) @@ -1,23 +1,20 @@ -/** @file psSpline.h - * @brief Standard Mathematical Functions. - * @ingroup GROUP00 +/* @file psSpline.h + * @brief Standard Mathematical Functions. * - * This file will hold the prototypes for procedures which allocate, free, - * and evaluate splines. + * This file will hold the prototypes for procedures which allocate, free, + * and evaluate splines. * - * XXX: What is the purpose of the SplineAlloc() function? + * @author GLG, MHPCC * - * @ingroup GROUP00 - * - * @author GLG, MHPCC - * - * @version $Revision: 1.60 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-06-30 02:20:06 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + * @version $Revision: 1.61 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ #ifndef PS_SPLINE_H #define PS_SPLINE_H + +/// @addtogroup MathOps Mathematical Operations +/// @{ #include @@ -32,8 +29,4 @@ #define PS_LEFT_SPLINE_DERIV 0.0 #define PS_RIGHT_SPLINE_DERIV 0.0 - -/** \addtogroup GROUP00 - * \{ - */ /** One-Dimensional Spline */ @@ -115,6 +108,4 @@ -/** \} */ // End of MathGroup Functions - +/// @} #endif // #ifndef PS_SPLINE_H - Index: /trunk/psLib/src/math/psStats.h =================================================================== --- /trunk/psLib/src/math/psStats.h (revision 11247) +++ /trunk/psLib/src/math/psStats.h (revision 11248) @@ -1,16 +1,14 @@ -/** @file psStats.h - * \brief basic statistical operations - * @ingroup Stats +/* @file psStats.h + * @brief basic statistical operations * - * This file will hold the definition of the histogram and stats data - * structures. It also contains prototypes for procedures which operate - * on those data structures. + * This file will hold the definition of the histogram and stats data + * structures. It also contains prototypes for procedures which operate + * on those data structures. * - * @author GLG, MHPCC + * @author GLG, MHPCC * - * @version $Revision: 1.58 $ $Name: not supported by cvs2svn $ - * @date $Date: 2007-01-19 04:32:27 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + * @version $Revision: 1.59 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ @@ -18,7 +16,5 @@ #define PS_STATS_H -// #include "psVector.h" - -/// @addtogroup Stats +/// @addtogroup MathOps Mathematical Operations /// @{ @@ -132,5 +128,4 @@ /// @} - #endif // #ifndef PS_STATS_H Index: /trunk/psLib/src/math/psUnaryOp.h =================================================================== --- /trunk/psLib/src/math/psUnaryOp.h (revision 11247) +++ /trunk/psLib/src/math/psUnaryOp.h (revision 11248) @@ -1,37 +1,36 @@ -/** @file psUnaryOp.h +/* @file psUnaryOp.h * - * @brief Provides unary functions for simple matrix and vector element operations. Functions - * include: + * @brief Provides unary functions for simple matrix and vector element operations * - * Addition (+) - * Subtraction (-) - * Multiplication (*) - * Division (/) - * Power (^) - * Minimum (min) - * Maximum (max) - * Absolute value (abs) - * Exponent (exp) - * Natural Log (ln) - * Power of 10 (ten) - * Log (log) - * Sine (sin or dsin) - * Cosine (cos or dcos) - * Tangent (tan or dtan) - * Arcsine (asin or dasin) - * Arccosine (acos or dacos) - * Arctan (atan or datan) + * Defined unary functions include: * - * Currently only vector-vector and image-image binary operations are supported. + * Addition (+) + * Subtraction (-) + * Multiplication (*) + * Division (/) + * Power (^) + * Minimum (min) + * Maximum (max) + * Absolute value (abs) + * Exponent (exp) + * Natural Log (ln) + * Power of 10 (ten) + * Log (log) + * Sine (sin or dsin) + * Cosine (cos or dcos) + * Tangent (tan or dtan) + * Arcsine (asin or dasin) + * Arccosine (acos or dacos) + * Arctan (atan or datan) * - * @ingroup MatrixArithmetic + * Currently only vector-vector and image-image binary operations are supported. * - * @author Ross Harman, MHPCC - * @author Robert DeSonia, MHPCC + * @author EAM, IfA + * @author Ross Harman, MHPCC + * @author Robert DeSonia, MHPCC * - * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ - * @date $Date: 2005-07-12 19:12:01 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ @@ -39,7 +38,6 @@ #define PSUNARY_OP_H -/// @addtogroup MatrixArithmetic +/// @addtogroup MathOps Mathematical Operations /// @{ - /** Perform simple unary arithmetic with images or vectors @@ -66,4 +64,3 @@ /// @} - #endif // #ifndef PSUNARY_OP_H Index: /trunk/psLib/src/math/psVectorSmooth.h =================================================================== --- /trunk/psLib/src/math/psVectorSmooth.h (revision 11247) +++ /trunk/psLib/src/math/psVectorSmooth.h (revision 11248) @@ -1,10 +1,15 @@ -/** @file psVectorSmooth.h +/* @file psVectorSmooth.h + * @brief smooth the input vector * - * smooth the input vector - * + * $Revision: 1.2 $ $Name: not supported by cvs2svn $ + * $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ #ifndef PS_VECTOR_SMOOTH_H #define PS_VECTOR_SMOOTH_H + +/// @addtogroup MathOps Mathematical Operations +/// @{ // Smooth a vector with a Gaussian @@ -14,4 +19,4 @@ double Nsigma // Number of standard deviations for Gaussian to extend (either side) ); - +/// @} #endif Index: /trunk/psLib/src/mathtypes/psImage.h =================================================================== --- /trunk/psLib/src/mathtypes/psImage.h (revision 11247) +++ /trunk/psLib/src/mathtypes/psImage.h (revision 11248) @@ -1,21 +1,21 @@ -/** @file psImage.h - * - * @brief Contains basic image definitions and operations - * - * This file defines the basic type for an image struct and functions useful - * in manupulating images. - * - * @ingroup Image - * - * @author Robert DeSonia, MHPCC - * @author Ross Harman, MHPCC - * - * @version $Revision: 1.83 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-11-09 20:20:27 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii - */ +/* @file psImage.h + * @brief Basic image definitions and operations + * + * This file defines the basic type for an image struct and functions useful + * in manupulating images. + * + * @author Robert DeSonia, MHPCC + * @author Ross Harman, MHPCC + * + * @version $Revision: 1.84 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + */ + #ifndef PS_IMAGE_H #define PS_IMAGE_H + +/// @addtogroup MathOps Mathematical Operations +/// @{ #include @@ -24,7 +24,4 @@ #include "psArray.h" #include "psConstants.h" - -/// @addtogroup Image -/// @{ /** enumeration of options in interpolation @@ -311,4 +308,3 @@ /// @} - #endif // PS_IMAGE_H Index: /trunk/psLib/src/mathtypes/psScalar.h =================================================================== --- /trunk/psLib/src/mathtypes/psScalar.h (revision 11247) +++ /trunk/psLib/src/mathtypes/psScalar.h (revision 11248) @@ -1,18 +1,13 @@ - -/** @file psScalar.h +/* @file psScalar.h + * @brief Basic scalar definitions and operations * - * @brief Contains basic scalar definitions and operations + * This file defines the basic type for a scalar struct and functions useful + * in manupulating scalars. * - * This file defines the basic type for a scalar struct and functions useful - * in manupulating scalars. + * @author Ross Harman, MHPCC * - * @ingroup Scalar - * - * @author Ross Harman, MHPCC - * - * @version $Revision: 1.20 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-01-28 01:12:14 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + * @version $Revision: 1.21 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ @@ -20,8 +15,8 @@ #define PS_SCALAR_H +/// @addtogroup MathOps Mathematical Operations +/// @{ + #include "psType.h" - -/// @addtogroup Scalar -/// @{ /** Basic scalar data structure. @@ -93,4 +88,3 @@ /// @} - #endif // #ifndef PS_SCALAR_H Index: /trunk/psLib/src/mathtypes/psVector.h =================================================================== --- /trunk/psLib/src/mathtypes/psVector.h (revision 11247) +++ /trunk/psLib/src/mathtypes/psVector.h (revision 11248) @@ -1,18 +1,15 @@ -/** @file psVector.h - * - * @brief Contains basic vector definitions and operations - * - * This file defines the basic type for a vector struct and functions useful - * in manupulating vectors. - * - * @ingroup Vector - * - * @author Robert DeSonia, MHPCC - * @author Ross Harman, MHPCC - * - * @version $Revision: 1.60 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-11-24 20:51:43 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii +/* @file psVector.h + * + * @brief basic vector definitions and operations + * + * This file defines the basic type for a vector struct and functions useful + * in manupulating vectors. + * + * @author Robert DeSonia, MHPCC + * @author Ross Harman, MHPCC + * + * @version $Revision: 1.61 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ @@ -20,10 +17,9 @@ #define PS_VECTOR_H -#include - +/// @addtogroup MathTypes Mathematical Structures +/// @{ + +#include #include "psType.h" - -/// @addtogroup Vector -/// @{ /** An vector to support primitive types. @@ -372,4 +368,3 @@ /// @} - #endif // #ifndef PS_VECTOR_H Index: /trunk/psLib/src/sys/psAbort.h =================================================================== --- /trunk/psLib/src/sys/psAbort.h (revision 11247) +++ /trunk/psLib/src/sys/psAbort.h (revision 11248) @@ -1,3 +1,2 @@ - /** @file psAbort.h * @@ -8,11 +7,8 @@ * needing to abort from program execution. * - * @ingroup ErrorHandling - * * @author Eric Van Alst, MHPCC * - * @version $Revision: 1.12 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-08-26 04:34:28 $ - * + * $Revision: 1.13 $ $Name: not supported by cvs2svn $ + * $Date: 2007-01-23 22:47:23 $ * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ @@ -21,9 +17,6 @@ #define PS_ABORT_H -// Doxygen grouping tags - -/** @addtogroup ErrorHandling - * @{ - */ +/// @addtogroup SysUtils System Utilities +/// @{ /** Reports an abort message to logging facility @@ -51,5 +44,4 @@ #endif // __GNUC__ -/** @} */ // Doxygen - End of SystemGroup Functions - +/// @} #endif // #ifndef PS_ABORT_H Index: /trunk/psLib/src/sys/psAssert.h =================================================================== --- /trunk/psLib/src/sys/psAssert.h (revision 11247) +++ /trunk/psLib/src/sys/psAssert.h (revision 11248) @@ -1,4 +1,7 @@ #ifndef PS_ASSERT_H #define PS_ASSERT_H + +/// @addtogroup SysUtils System Utilities +/// @{ #include @@ -263,3 +266,4 @@ +/// @} #endif Index: /trunk/psLib/src/sys/psConfigure.h =================================================================== --- /trunk/psLib/src/sys/psConfigure.h (revision 11247) +++ /trunk/psLib/src/sys/psConfigure.h (revision 11248) @@ -1,6 +1,5 @@ /** @file psConfigure.h * - * @brief Contains the declarations for initialization, memory finalization, - * and configuration. + * @brief Functions to init and cleanup psLib * * These functions initalize psLib data before the beginning of a run and @@ -8,11 +7,10 @@ * also provided to return the current psLib version. * - * @ingroup Configure * * @author Ross Harman, MHPCC * @author Robert DeSonia, MHPCC * - * @version $Revision: 1.9 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-11-29 21:33:09 $ + * @version $Revision: 1.10 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -22,7 +20,6 @@ #define PS_CONFIGURE_H -/** @addtogroup Configure - * @{ - */ +/// @addtogroup SysUtils System Utilities +/// @{ /** Get current psLib version @@ -70,5 +67,4 @@ void p_psMemoryCheck(void); -/** @} */ - +/// @} #endif // #ifndef PS_CONFIGURE_H Index: /trunk/psLib/src/sys/psError.h =================================================================== --- /trunk/psLib/src/sys/psError.h (revision 11247) +++ /trunk/psLib/src/sys/psError.h (revision 11248) @@ -1,5 +1,5 @@ /** @file psError.h * - * @brief Contains the declarations for the error reporting functions + * @brief error reporting functions * * Error reporting functions shall be used to create log entries in the @@ -8,10 +8,9 @@ * of error detected. * - * @ingroup ErrorHandling - * + * @author RHL, Princeton * @author Eric Van Alst, MHPCC * - * @version $Revision: 1.31 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-09-12 21:39:47 $ + * @version $Revision: 1.32 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -20,4 +19,7 @@ #ifndef PS_ERROR_H #define PS_ERROR_H + +/// @addtogroup SysUtils System Utilities +/// @{ #include @@ -28,8 +30,4 @@ #define _(string) string - -/** @addtogroup ErrorHandling - * @{ - */ /** Error message object */ @@ -231,5 +229,4 @@ ); -/* @} */// End of SysUtils Functions - +/// @} #endif Index: /trunk/psLib/src/sys/psErrorCodes.h.in =================================================================== --- /trunk/psLib/src/sys/psErrorCodes.h.in (revision 11247) +++ /trunk/psLib/src/sys/psErrorCodes.h.in (revision 11248) @@ -3,10 +3,9 @@ * @brief Contains the error codes for the error classes * - * @ingroup ErrorHandling - * + * @author RHL, Princeton * @author Robert DeSonia, MHPCC * - * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-07-25 00:30:31 $ + * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -16,9 +15,8 @@ #define PS_ERROR_CODES_H +/// @addtogroup SysUtils System Utilities +/// @{ + #include "psType.h" - -/** @addtogroup ErrorHandling - * @{ - */ /** enumeration of the static error code classes @@ -84,4 +82,3 @@ /// @} - #endif // #ifndef PS_ERROR_CODES_H Index: /trunk/psLib/src/sys/psExit.h =================================================================== --- /trunk/psLib/src/sys/psExit.h (revision 11247) +++ /trunk/psLib/src/sys/psExit.h (revision 11248) @@ -1,4 +1,7 @@ #ifndef PS_EXIT_H #define PS_EXIT_H + +/// @addtogroup SysUtils System Utilities +/// @{ /// Exit status codes @@ -15,3 +18,4 @@ } psExit; +/// @} #endif Index: /trunk/psLib/src/sys/psLine.h =================================================================== --- /trunk/psLib/src/sys/psLine.h (revision 11247) +++ /trunk/psLib/src/sys/psLine.h (revision 11248) @@ -1,16 +1,14 @@ /** @file psLine.h * - * - * @brief Contains the declarations of line utility functions - * - * @ingroup SysUtils + * @brief charater-string fixed-length line functions * * The psLine functions allow manipulation of fixed-length lines. * + * @author EAM, IFA * @author Paul Price, IFA * @author David Robbins, MHPCC * - * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-07-21 02:39:33 $ + * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -20,9 +18,8 @@ #define PS_LINE_H +/// @addtogroup SysUtils System Utilities +/// @{ + #include "psString.h" - -/** @addtogroup SysUtils - * @{ - */ /** Structure to carry a dynamic string */ @@ -77,3 +74,4 @@ ); +/// @} #endif /* PS_LINE_H */ Index: /trunk/psLib/src/sys/psLogMsg.h =================================================================== --- /trunk/psLib/src/sys/psLogMsg.h (revision 11247) +++ /trunk/psLib/src/sys/psLogMsg.h (revision 11248) @@ -1,28 +1,27 @@ /** @file psLogMsg.h + * * @brief Procedures for logging messages. - * \ingroup LogTrace * * This file will hold the prototypes for defining procedure which set * message log levels, messahe log formats, message log destinations, and * for generating the messages themselves. - * @ingroup LogTrace * * @author Robert Lupton, Princeton University * @author GLG, MHPCC * - * @version $Revision: 1.37 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-12-04 20:45:46 $ + * @version $Revision: 1.38 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ + #ifndef PS_LOG_MSG_H #define PS_LOG_MSG_H + +/// @addtogroup SysUtils System Utilities +/// @{ + #include - #include "psType.h" - -/** @addtogroup LogTrace - * @{ - */ /** This procedure sets the destination for future log messages. @@ -137,4 +136,3 @@ /// @} - #endif // #ifndef PS_LOG_MSG_H Index: /trunk/psLib/src/sys/psMemory.h =================================================================== --- /trunk/psLib/src/sys/psMemory.h (revision 11247) +++ /trunk/psLib/src/sys/psMemory.h (revision 11248) @@ -1,19 +1,16 @@ -/** @file psMemory.h - * - * @brief Contains the definitions for the memory management system - * - * This is the generic memory management system put inbetween the user's high level code and the OS-level - * memory allocation routines. This system adds such features as callback routines for memory error events, - * tracing capabilities, and reference counting. - * - * @author Robert DeSonia, MHPCC - * @author Robert Lupton, Princeton University - * - * @ingroup MemoryManagement - * - * @version $Revision: 1.61 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-10-13 21:13:48 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii +/* @file psMemory.h + * + * @brief Contains the definitions for the memory management system + * + * This is the generic memory management system put inbetween the user's high level code and the OS-level + * memory allocation routines. This system adds such features as callback routines for memory error events, + * tracing capabilities, and reference counting. + * + * @author Robert Lupton, Princeton University + * @author Robert DeSonia, MHPCC + * + * $Revision: 1.62 $ $Name: not supported by cvs2svn $ + * $Date: 2007-01-23 22:47:23 $ + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ @@ -21,32 +18,12 @@ #define PS_MEMORY_H +/// @addtogroup SysUtils System Utilities +/// @{ + #include // needed for FILE #include // we need a mutex to make this stuff thread safe. - #include "psType.h" -/** @addtogroup MemoryManagement - * @{ - */ - #define P_PS_MEMMAGIC (psPtr)0xdeadbeef // Magic number in psMemBlock header - -/** - * @addtogroup memCallback Memory Callbacks - * - * Routines dealing with the creating and setting of memory management callback functions. - */ - -/** - * @addtogroup memTracing Memory Tracing - * - * Routines dealing with memory tracing and corruption checking. - */ - -/** - * @addtogroup memRefCount Reference Count - * - * Routines dealing with the reference counting of allocated buffers. - */ /// typedef for memory identification numbers. Guaranteed to be some variety of integer. @@ -84,5 +61,4 @@ * * @see psMemAllocCallbackSet - * @ingroup memCallback */ typedef psMemId(*psMemAllocCallback) ( @@ -93,5 +69,4 @@ * * @see psMemFreeCallbackSet - * @ingroup memCallback */ typedef psMemId(*psMemFreeCallback) ( @@ -104,5 +79,4 @@ * * @see psMemProblemCallbackSet - * @ingroup memCallback */ typedef void (*psMemProblemCallback) ( @@ -118,5 +92,4 @@ * * @see psMemExhaustedCallbackSet - * @ingroup memCallback */ typedef psPtr (*psMemExhaustedCallback) ( @@ -303,5 +276,4 @@ * blocks above id0 that have not been freed. * @see psAlloc, psFree, psgetMemId, psMemProblemCallbackSet - * @ingroup memTracing */ int psMemCheckLeaks( @@ -317,5 +289,4 @@ * @return int * - * @ingroup memTracing */ int psMemCheckCorruption( @@ -327,5 +298,4 @@ * @return psReferenceCount * - * @ingroup memRefCount */ psReferenceCount psMemGetRefCounter( @@ -337,5 +307,4 @@ * @return psPtr * - * @ingroup memRefCount */ #ifdef DOXYGEN @@ -358,5 +327,4 @@ /** Decrement reference counter and return the pointer * - * @ingroup memRefCount * * @return psPtr the pointer deremented in refCount, or NULL if pointer is @@ -381,6 +349,4 @@ /** Set reference counter and return the pointer - * - * @ingroup memRefCount * * @return psPtr the pointer with refCount set, or NULL if pointer is @@ -411,6 +377,4 @@ * stack. If any of these checks discover that the memory stack is corrupted, * the psMemProblemCallback is called. - - * @ingroup memCallback * * @return psMemProblemCallback old psMemProblemCallback function @@ -431,6 +395,4 @@ * request and try again, limiting the size of the operating buffer. * - * @ingroup memCallback - * * @return psMemExhaustedCallback old psMemExhaustedCallback function */ @@ -446,6 +408,4 @@ * just before memory is returned to the calling function. * - * @ingroup memCallback - * * @return psMemAllocCallback old psMemAllocCallback function */ @@ -461,6 +421,4 @@ * before the memory block is freed. * - * @ingroup memCallback - * * @return psMemFreeCallback old psMemFreeCallback function */ @@ -471,6 +429,4 @@ /** get next memory ID * - * @ingroup memCallback - * * @return psMemId the next memory ID to be used */ @@ -478,6 +434,4 @@ /** get the last memory ID used - * - * @ingroup memCallback * * @return psMemId the last memory ID used @@ -492,6 +446,4 @@ * just before memory is returned to the calling function. * - * @ingroup memCallback - * * @return psMemId * @@ -509,6 +461,4 @@ * before the memory block is freed. * - * @ingroup memCallback - * * @return psMemId the old p_psMemFreeID * @@ -530,5 +480,5 @@ size_t *freelist); ///< memory that's waiting to be recycled -//@} End of Memory Management Functions +/// @} end of SysUtils #ifndef DOXYGEN @@ -549,4 +499,3 @@ #endif // #ifndef DOXYGEN - #endif // #ifndef PS_MEMORY_H Index: /trunk/psLib/src/sys/psSlurp.h =================================================================== --- /trunk/psLib/src/sys/psSlurp.h (revision 11247) +++ /trunk/psLib/src/sys/psSlurp.h (revision 11248) @@ -1,4 +1,15 @@ +/* @file psSlurp.h + * @brief read complete files into strings + * + * @author JH + * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + */ + #ifndef PS_SLURP_H #define PS_SLURP_H + +/// @addtogroup FileIO Input/Output +/// @{ // Read ("slurp") a file (specified by file descriptor) @@ -12,4 +23,4 @@ ); - +/// @} #endif Index: /trunk/psLib/src/sys/psString.h =================================================================== --- /trunk/psLib/src/sys/psString.h (revision 11247) +++ /trunk/psLib/src/sys/psString.h (revision 11248) @@ -1,25 +1,24 @@ -/** @file psString.h - * - * -*- mode: C; c-basic-indent: 4; tab-width: 8; indent-tabs-mode: nil -*- - * vim: set cindent ts=8 sw=4 expandtab: - * - * @brief Contains the declarations of string utility functions - * - * @ingroup SysUtils - * - * String utility functions defined shall provide basic string copying - * capabilities. - * - * @author Eric Van Alst, MHPCC - * @author David Robbins, MHPCC - * - * @version $Revision: 1.34 $ $Name: not supported by cvs2svn $ - * @date $Date: 2007-01-06 04:13:51 $ - * - * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii +/* @file psString.h + * + * @brief string utility functions + * + * String utility functions defined shall provide basic string copying + * capabilities. + * + * @author EAM, IfA + * @author Eric Van Alst, MHPCC + * @author David Robbins, MHPCC + * + * @version $Revision: 1.35 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ #ifndef PS_STRING_H #define PS_STRING_H + +/// @addtogroup SysUtils System Utilities +/// @{ #include @@ -35,10 +34,4 @@ const char *p_psFileLine(const char *file, int line); #define PS_FILE_LINE p_psFileLine(__FILE__,__LINE__) - -// Doxygen group tags - -/** @addtogroup SysUtils - * @{ - */ /** Allocates a new psString. @@ -230,5 +223,4 @@ #endif // ifndef DOXYGEN -/** @} */// Doxygen - End of SystemGroup Functions - +/// @} #endif // #ifndef PS_STRING_H Index: /trunk/psLib/src/sys/psTrace.h =================================================================== --- /trunk/psLib/src/sys/psTrace.h (revision 11247) +++ /trunk/psLib/src/sys/psTrace.h (revision 11248) @@ -1,5 +1,5 @@ /** @file psTrace.h - * \brief basic run-time trace facilities - * \ingroup LogTrace + * + * @brief basic run-time trace facilities * * This file will hold the prototypes for defining procedures to insert @@ -9,11 +9,16 @@ * @author GLG, MHPCC * - * @version $Revision: 1.52 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-10-13 22:29:23 $ + * @version $Revision: 1.53 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ -#if !defined(PS_TRACE_H) + +#ifndef PS_TRACE_H #define PS_TRACE_H 1 + +/// @addtogroup SysUtils System Utilities +/// @{ + #include @@ -21,8 +26,4 @@ #define PS_DEFAULT_TRACE_LEVEL -1 #define PS_THE_OTHER_DEFAULT_TRACE_LEVEL 0 - -/** \addtogroup LogTrace - * \{ - */ enum { @@ -171,8 +172,5 @@ int psTraceGetDestination(void); -/* \} */// End of SystemGroup Functions - +/// @} #endif /* PS_NO_TRACE */ - #endif /* PS_TRACE_H */ - Index: /trunk/psLib/src/sys/psType.h =================================================================== --- /trunk/psLib/src/sys/psType.h (revision 11247) +++ /trunk/psLib/src/sys/psType.h (revision 11248) @@ -1,21 +1,22 @@ -/** @file psType.h -* -* @brief Contains support for basic types -* -* This file defines common datatypes used throughout psLib. -* -* @ingroup DataContainer -* -* @author Robert DeSonia, MHPCC -* @author Ross Harman, MHPCC -* -* @version $Revision: 1.52 $ $Name: not supported by cvs2svn $ -* @date $Date: 2006-10-14 00:02:31 $ -* -* Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii -*/ +/* @file psType.h + * + * @brief Contains support for basic types + * + * This file defines common datatypes used throughout psLib. + * + * @author Robert DeSonia, MHPCC + * @author Ross Harman, MHPCC + * + * @version $Revision: 1.53 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * + * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii + */ #ifndef PS_TYPE_H #define PS_TYPE_H + +/// @addtogroup DataContainer Data Containers +/// @{ #include @@ -23,7 +24,4 @@ #include #include - -/// @addtogroup DataContainer -/// @{ /******************************************************************************/ @@ -301,4 +299,3 @@ /// @} - #endif // #ifndef PS_TYPE_H Index: /trunk/psLib/src/types/psArguments.h =================================================================== --- /trunk/psLib/src/types/psArguments.h (revision 11247) +++ /trunk/psLib/src/types/psArguments.h (revision 11248) @@ -3,10 +3,8 @@ * @brief Contains operations for parsing command line input arguments. * - * @ingroup Arguments - * * @author David Robbins, MHPCC * - * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-10-13 21:13:48 $ + * @version $Revision: 1.4 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -16,5 +14,5 @@ #define PS_ARGUMENTS_H -/// @addtogroup Arguments +/// @addtogroup SysUtils /// @{ @@ -57,7 +55,7 @@ * * The input arguments shall contain the list of possible arguments as the keywords providing - * the default values. As matching arguments are found on the command line, the values shall be - * read into the arguments metadata, with the appropriate type. The arguments and their values - * shall be removed from the list of command line arguments as they are processed. + * the default values. As matching arguments are found on the command line, the values shall + * be read into the arguments metadata, with the appropriate type. The arguments and their + * values shall be removed from the list of command line arguments as they are processed. * * @return bool: False if any argument was encountered that is not present in arguments. @@ -74,6 +72,4 @@ ); - /// @} - #endif // #ifndef PS_ARGUMENTS_H Index: /trunk/psLib/src/types/psArray.h =================================================================== --- /trunk/psLib/src/types/psArray.h (revision 11247) +++ /trunk/psLib/src/types/psArray.h (revision 11248) @@ -6,11 +6,9 @@ * in manupulating arrays. * - * @ingroup Array - * * @author Robert DeSonia, MHPCC * @author Ross Harman, MHPCC * - * @version $Revision: 1.44 $ $Name: not supported by cvs2svn $ - * @date $Date: 2007-01-12 21:58:09 $ + * @version $Revision: 1.45 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -23,5 +21,5 @@ #include "psCompare.h" -/// @addtogroup Array +/// @addtogroup DataContainer Data Containers /// @{ @@ -231,4 +229,3 @@ /// @} - #endif // #ifndef PS_ARRAY_H Index: /trunk/psLib/src/types/psBitSet.h =================================================================== --- /trunk/psLib/src/types/psBitSet.h (revision 11247) +++ /trunk/psLib/src/types/psBitSet.h (revision 11248) @@ -8,10 +8,9 @@ * string. * - * @ingroup BitSet - * + * @author PAP, EAM, IfA * @author Ross Harman, MHPCC * - * @version $Revision: 1.27 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-10-01 00:40:35 $ + * @version $Revision: 1.28 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -23,5 +22,5 @@ #include "psType.h" -/// @addtogroup BitSet +/// @addtogroup DataContainer Data Containers /// @{ @@ -151,4 +150,3 @@ /// @} - #endif // #ifndef PSBITSET_H Index: /trunk/psLib/src/types/psHash.h =================================================================== --- /trunk/psLib/src/types/psHash.h (revision 11247) +++ /trunk/psLib/src/types/psHash.h (revision 11248) @@ -1,5 +1,5 @@ /** @file psHash.h + * * @brief Contains support for basic hashing functions. - * @ingroup HashTable * * This file will hold the prototypes for defining a hash table with arbitrary @@ -11,6 +11,6 @@ * @author GLG, MHPCC * - * @version $Revision: 1.19 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-10-01 00:45:34 $ + * @version $Revision: 1.20 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -20,7 +20,6 @@ #define PS_HASH_H -/** \addtogroup HashTable - * \{ - */ +/// @addtogroup DataContainer Data Containers +/// @{ #include "psList.h" @@ -94,5 +93,4 @@ ); -/* \} */// End of DataGroup Functions - +/// @} End of DataContainer Functions #endif // #ifndef PS_HASH_H Index: /trunk/psLib/src/types/psList.h =================================================================== --- /trunk/psLib/src/types/psList.h (revision 11247) +++ /trunk/psLib/src/types/psList.h (revision 11248) @@ -5,8 +5,6 @@ * @author Robert Daniel DeSonia, MHPCC * - * @ingroup LinkedList - * - * @version $Revision: 1.38 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-10-02 06:05:53 $ + * @version $Revision: 1.39 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -19,7 +17,6 @@ #include "psArray.h" -/** @addtogroup LinkedList - * @{ - */ +/// @addtogroup DataContainer Data Containers +/// @{ /** Special values of index into list @@ -238,7 +235,4 @@ ); - -/// @} End of DataGroup Functions - +/// @} End of DataContainer Functions #endif // #ifndef PS_LIST_H - Index: /trunk/psLib/src/types/psLookupTable.h =================================================================== --- /trunk/psLib/src/types/psLookupTable.h (revision 11247) +++ /trunk/psLib/src/types/psLookupTable.h (revision 11248) @@ -3,10 +3,9 @@ * @brief This file defines the structure and functions for table lookups. * -* @ingroup types -* +* @author PAP, IfA * @author Ross Harman, MHPCC * -* @version $Revision: 1.16 $ $Name: not supported by cvs2svn $ -* @date $Date: 2006-10-22 00:51:05 $ +* @version $Revision: 1.17 $ $Name: not supported by cvs2svn $ +* @date $Date: 2007-01-23 22:47:23 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -15,4 +14,7 @@ #ifndef PS_LOOKUPTABLE_H #define PS_LOOKUPTABLE_H + +/// @addtogroup DataContainer Data Containers +/// @{ #include "psType.h" @@ -143,3 +145,4 @@ ); +/// @} #endif // #ifndef PS_LOOKUPTABLE_H Index: /trunk/psLib/src/types/psMetadata.h =================================================================== --- /trunk/psLib/src/types/psMetadata.h (revision 11247) +++ /trunk/psLib/src/types/psMetadata.h (revision 11248) @@ -6,11 +6,9 @@ * prototypes necessary creating psLib metadata APIs * -* @ingroup Metadata -* * @author Robert DeSonia, MHPCC * @author Ross Harman, MHPCC * -* @version $Revision: 1.93 $ $Name: not supported by cvs2svn $ -* @date $Date: 2006-11-29 22:41:02 $ +* @version $Revision: 1.94 $ $Name: not supported by cvs2svn $ +* @date $Date: 2007-01-23 22:47:23 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -19,4 +17,7 @@ #define PS_METADATA_H +/// @addtogroup DataContainer Data Containers +/// @{ + #include #include @@ -28,7 +29,4 @@ #include "psTime.h" #include "psLookupTable.h" - -/// @addtogroup Metadata -/// @{ #define PS_DATA_IS_PRIMITIVE(TYPE) \ @@ -1199,6 +1197,4 @@ } - /// @} - #endif // #ifndef PS_METADATA_H Index: /trunk/psLib/src/types/psMetadataConfig.h =================================================================== --- /trunk/psLib/src/types/psMetadataConfig.h (revision 11247) +++ /trunk/psLib/src/types/psMetadataConfig.h (revision 11248) @@ -5,11 +5,12 @@ * This file defines functions to read and write metadata to/from an external file. * - * @ingroup Metadata - * + * @author EAM, IfA + * @author PAP, IfA + * @author JH, IfA * @author Ross Harman, MHPCC * @author Robert DeSonia, MHPCC * - * @version $Revision: 1.25 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-10-24 22:52:56 $ + * @version $Revision: 1.26 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -20,5 +21,5 @@ #include "psMetadata.h" -/// @addtogroup Metadata +/// @addtogroup DataContainer Data Containers /// @{ @@ -98,4 +99,3 @@ /// @} - #endif // #ifndef PS_METADATAIO_H Index: /trunk/psLib/src/types/psMetadataItemCompare.h =================================================================== --- /trunk/psLib/src/types/psMetadataItemCompare.h (revision 11247) +++ /trunk/psLib/src/types/psMetadataItemCompare.h (revision 11248) @@ -5,10 +5,8 @@ * This file defines functions to compare psMetadataItem's. * - * @ingroup Metadata - * * @author IFA * - * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-08-08 01:27:45 $ + * @version $Revision: 1.3 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii @@ -20,5 +18,5 @@ #include "psMetadata.h" -/// @addtogroup Metadata +/// @addtogroup DataContainer Data Containers /// @{ @@ -33,6 +31,4 @@ ; - /// @} - #endif Index: /trunk/psLib/src/types/psMetadataItemParse.h =================================================================== --- /trunk/psLib/src/types/psMetadataItemParse.h (revision 11247) +++ /trunk/psLib/src/types/psMetadataItemParse.h (revision 11248) @@ -1,4 +1,19 @@ +/** @file psMetadataItemParse.h +* +* @brief Parse metadata items +* +* @author EAM, PAP, JH, RHL, +* +* @version $Revision: 1.2 $ $Name: not supported by cvs2svn $ +* @date $Date: 2007-01-23 22:47:23 $ +* +* Copyright 2004-2005 IfA, University of Hawaii +*/ + #ifndef PS_METADATA_ITEM_PARSE_H #define PS_METADATA_ITEM_PARSE_H + +/// @addtogroup DataContainer Data Containers +/// @{ #include "psType.h" @@ -17,3 +32,4 @@ psString psMetadataItemParseString(const psMetadataItem *item); +/// @} #endif Index: /trunk/psLib/src/types/psPixels.h =================================================================== --- /trunk/psLib/src/types/psPixels.h (revision 11247) +++ /trunk/psLib/src/types/psPixels.h (revision 11248) @@ -3,13 +3,13 @@ * @brief Contains psPixel related functions * - * @ingroup Image - * + * @author Paul Price, IfA * @author Robert DeSonia, MHPCC * - * @version $Revision: 1.23 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-09-26 02:55:34 $ + * @version $Revision: 1.24 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ * * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii */ + #ifndef PS_PIXELS_H #define PS_PIXELS_H @@ -19,5 +19,5 @@ #include "psRegion.h" -/// @addtogroup Image +/// @addtogroup DataContainer Data Containers /// @{ @@ -197,3 +197,4 @@ ); +/// @} #endif // #ifndef PS_PIXELS_H Index: /trunk/psLib/src/xml/psXML.h =================================================================== --- /trunk/psLib/src/xml/psXML.h (revision 11247) +++ /trunk/psLib/src/xml/psXML.h (revision 11248) @@ -1,21 +1,20 @@ -/** @file psXML.h +/* @file psXML.h + * @brief Contains basic XML definitions and operations * - * @brief Contains basic XML definitions and operations + * This file defines the basic type for an XML struct and functions useful + * in creation and usage of XML documents/files. * - * This file defines the basic type for an XML struct and functions useful - * in creation and usage of XML documents/files. + * @author David Robbins, MHPCC * - * @ingroup XML - * - * @author David Robbins, MHPCC - * - * @version $Revision: 1.20 $ $Name: not supported by cvs2svn $ - * @date $Date: 2006-08-08 23:32:23 $ - * - * Copyright 2005 Maui High Performance Computing Center, University of Hawaii + * @version $Revision: 1.21 $ $Name: not supported by cvs2svn $ + * @date $Date: 2007-01-23 22:47:23 $ + * Copyright 2005 Maui High Performance Computing Center, University of Hawaii */ #ifndef PS_XML_H #define PS_XML_H + +/// @addtogroup FileIO Input/Output +/// @{ #include @@ -32,9 +31,4 @@ #include "psConstants.h" #include "psTime.h" - - - -/// @addtogroup XML -/// @{ /** XML wrapper pointing to an XML document in memory */ @@ -124,5 +118,3 @@ /// @} - #endif // #ifndef PS_XML_H -