Changeset 21229 for branches/eam_branch_20081230/ppArith/src/ppArith.h

Timestamp:

Jan 29, 2009, 3:39:49 PM (17 years ago)

Author:

giebink

Message:

Doxygen place holders added

File:

• branches/eam_branch_20081230/ppArith/src/ppArith.h (modified) (1 diff)

branches/eam_branch_20081230/ppArith/src/ppArith.h

@@ +1 @@
+/** @file ppArith.h
+ *
+ *  @brief
+ *
+ *  @ingroup ppArith
+ *
+ *  @author IfA
+ *  @version $Revision: 1.3.32.1 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2009-01-30 01:37:55 $
+ *  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
+bool ppArithArguments(int argc, char *argv[], /**< Command-line arguments */
+                      pmConfig *config    /**< Configuration */
     );
 
 /// Parse the camera input
-bool ppArithCamera(pmConfig *config       ///< Configuration
+bool ppArithCamera(pmConfig *config       /**< Configuration */
     );
 
 /// Loop over the FPA hierarchy
-bool ppArithLoop(pmConfig *config         ///< Configuration
+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
+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
-void ppArithVersionMetadata(psMetadata *metadata ///< Metadata to populate
+void ppArithVersionMetadata(psMetadata *metadata /**< Metadata to populate */
     );
 
+///@}
 
 #endif