Changeset 846 for trunk/src/STFiller.h

Timestamp:

02/23/06 11:26:32 (18 years ago)

Author:

mar637

Message:

added ignor porperties

Location:

trunk/src

Files:

• . (modified) (1 prop)
• STFiller.h (modified) (5 diffs)

trunk/src/STFiller.h

@@ -33 +33 @@
 This class fills a Scantable from external data formats using the PKSReader class.
 
+@brief    A filler object for data import into Scantable
 @author   Malte Marquarding
 @date     2006/01/16
@@ -40 +41 @@
 public:
 
+  /**
+   * Default constructor
+   */
   STFiller();
 
+
+  /**
+   * Constructor taking an existing Scantable to fill
+   * @param stbl
+   */
   STFiller(casa::CountedPtr< Scantable > stbl);
 
@@ -54 +63 @@
                   int whichBeam=-1 );
 
+  /**
+   * Destructor
+   */
   ~STFiller();
 
@@ -66 +78 @@
 
   /**
-   * detatch from file
+   * detach from file and clean up pointers
    */
   void close( );
@@ -73 +85 @@
    * Read in "rows" from the source file attached with open()
    * @return a status flag passed on by PKSreader
+   *
+   * @li @c 0: ok
+   * @li >0: failed
    */
   int read( );