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

Timestamp:

Jan 30, 2009, 12:00:45 PM (17 years ago)

Author:

giebink

Message:

Doxygen comments made consistent

File:

• branches/eam_branch_20081230/ppArith/src/ppArith.h (modified) (2 diffs)

branches/eam_branch_20081230/ppArith/src/ppArith.h

@@ -6 +6 @@
  *
  *  @author IfA
- *  @version $Revision: 1.3.32.1 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2009-01-30 01:37:55 $
+ *  @version $Revision: 1.3.32.2 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2009-01-30 22:00:45 $
  *  Copyright 2009 Institute for Astronomy, University of Hawaii
  */
@@ -17 +17 @@
 /// @addtogroup ppArith
 /// @{
-#define PPARITH_RECIPE "PPARITH"            /** Name of the recipe to use */
+#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
-void ppArithVersionMetadata(psMetadata *metadata /**< Metadata to populate */
+/**
+ * Put the program version information into a metadata
+ */
+void ppArithVersionMetadata(psMetadata *metadata ///< Metadata to populate
     );