Changeset 21244 for trunk/ppArith/src/ppArith.h

Timestamp:

Feb 1, 2009, 11:43:05 AM (17 years ago)

Author:

eugene

Message:

merging Doxygen templates added by Bill G

File:

• trunk/ppArith/src/ppArith.h (modified) (1 diff)

trunk/ppArith/src/ppArith.h

@@ +1 @@
+/** @file ppArith.h
+ *
+ *  @brief
+ *
+ *  @ingroup ppArith
+ *
+ *  @author IfA
+ *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2009-02-01 21:40:52 $
+ *  Copyright 2009 Institute for Astronomy, University of Hawaii
+ */
+
+
 #ifndef PP_ARITH_H
 #define PP_ARITH_H
 
-#define PPARITH_RECIPE "PPARITH"            /// Name of the recipe to use
+/// @addtogroup ppArith
+/// @{
+#define PPARITH_RECIPE "PPARITH"            ///< Name of the recipe to use
 
-/// Parse the arguments
-bool ppArithArguments(int argc, char *argv[], ///< Command-line arguments
-                      pmConfig *config    ///< Configuration
+/**
+ * Parse the arguments
+ */
+bool ppArithArguments(int argc, char *argv[], ///< Command-line arguments 
+                      pmConfig *config    ///< Configuration 
     );
 
-/// Parse the camera input
-bool ppArithCamera(pmConfig *config       ///< Configuration
+/**
+ * Parse the camera input
+ */
+bool ppArithCamera(pmConfig *config       ///< Configuration 
     );
 
-/// Loop over the FPA hierarchy
-bool ppArithLoop(pmConfig *config         ///< Configuration
+/**
+ * Loop over the FPA hierarchy
+ */
+bool ppArithLoop(pmConfig *config         ///< Configuration 
     );
 
-/// Perform arithmetic on the readout
-bool ppArithReadout(pmReadout *output,  ///< Output readout
-                    const pmReadout *input1, ///< Input readout
-                    const pmReadout *input2, ///< Input readout
-                    const pmConfig *config, ///< Configuration
-                    const pmFPAview *view ///< View of readout on which to operate
+/**
+ * Perform arithmetic on the readout
+ */
+bool ppArithReadout(pmReadout *output,  ///< Output readout 
+                    const pmReadout *input1, ///< Input readout 
+                    const pmReadout *input2, ///< Input readout 
+                    const pmConfig *config, ///< Configuration 
+                    const pmFPAview *view ///< View of readout on which to operate 
     );
 
-/// Put the program version information into a metadata
+/**
+ * Put the program version information into a metadata
+ */
 void ppArithVersionMetadata(psMetadata *metadata ///< Metadata to populate
     );
 
+///@}
 
 #endif