Changeset 848 for trunk/src

Timestamp:

02/24/06 11:31:22 (19 years ago)

Author:

mar637

Message:

DOcumentation update

File:

• trunk/src/STWriter.h (modified) (2 diffs)

trunk/src/STWriter.h

@@ -44 +44 @@
 
 namespace asap {
-
+/**
+  * This exports the ASAP internal data format to othe formats,
+  * such as "SDFITS", "FITS", "MS2" or "ASCII"
+  *
+  * @brief Export of ASAP data container into forign formats
+  * @author Malte Marquarding
+  * @date $Date:$
+  * @version 2.0a
+*/
 class STWriter : public SDLog {
 public:
@@ -50 +58 @@
   ~STWriter();
 
-// Format can be "SDFITS", "FITS", "MS2" or "ASCII"
-// Stokes conversion available for FITS and ASCII at present
-  casa::Int setFormat(const string &format = "SDFITS");
+  /**
+   * Set the format the data should be exported in
+   * @param format an be "SDFITS", "FITS", "MS2" or "ASCII"
+   * @return ststus code from PKSwriter
+   */
+  casa::Int setFormat(const string& format = "SDFITS");
+
+  /**
+   * Write the data to a file (directory)
+   * @param table the Scantable object
+   * @param filename the output file name
+   * @return
+   */
   casa::Int write(const casa::CountedPtr<Scantable> table,
-            const string &filename);
+            const string& filename);
 
 private: