Changeset 1104 for trunk/src/Scantable.h

Timestamp:

08/02/06 14:58:50 (18 years ago)

Author:

mar637

Message:

added doxygen documentation

File:

• trunk/src/Scantable.h (modified) (5 diffs)

trunk/src/Scantable.h

@@ -90 +90 @@
   /**
    * get a const reference to the underlying casa::Table
-   * @return consantcasa::Table reference
+   * @return const \ref casa::Table reference
    */
   const casa::Table& table() const;
@@ -146 +146 @@
 
   /**
-   * return the number of scans in the table
+   * The number of scans in the table
    * @return number of scans in the table
    */
@@ -159 +159 @@
   casa::MPosition getAntennaPosition() const;
 
+        /**
+         * the @ref casa::MDirection for a specific row
+         * @param[in] whichrow the row number 
+         * return casa::MDirection
+         */
   casa::MDirection getDirection( int whichrow ) const;
 
+        /**
+         * get the direction type as a string, e.g. "J2000"
+         * @param[in] whichrow the row number
+         * return the direction string
+         */
   std::string getDirectionString( int whichrow ) const;
 
+        /**
+         * set the direction type as a string, e.g. "J2000"
+         * @param[in] the direction type
+         */     
   void setDirectionRefString(const std::string& refstr="");
-
-  std::string getDirectionRefString() const;
+  /**
+   * get the direction reference string
+   * @return a string describing the direction reference
+   */
+  std::string getDirectionRefString() const;    /**
+         * get the direction type as a string, e.g. "J2000"
+         * param[in] whichrow the row number
+         * return the direction string
+         */
+  
 
   /**
@@ -192 +214 @@
   /**
    * "hard" flag the data, this flags everything selected in setSelection()
+   * param[in] msk a boolean mask of length nchan describing the points to
+   * to be flagged
    */
   void flag( const std::vector<bool>& msk = std::vector<bool>());
@@ -239 +263 @@
    * @param scanno the scan number to get the number of rows for.
    * If scanno<0 the number is retrieved from the header.
-   * @return
+   * @return the number of rows (for the specified scanno)
    */
   int nrow(int scanno=-1) const;