[Gnash-commit] /srv/bzr/gnash/rtmp r9692: Finish up doxygen comnments for all the accessor methods.

[rob]

------------------------------------------------------------
revno: 9692
committer: address@hidden
branch nick: rtmp
timestamp: Mon 2008-11-03 12:25:44 -0700
message:
  Finish up doxygen comnments for all the accessor methods.
modified:
  cygnal/crc.h

=== modified file 'cygnal/crc.h'
--- a/cygnal/crc.h      2008-11-03 01:01:42 +0000
+++ b/cygnal/crc.h      2008-11-03 19:25:44 +0000
@@ -54,24 +54,43 @@
     bool loadFiles();
     
     /// \brief Parse and load configuration file
+    ///
+    /// @param filespec The path and file name of the disk file to parse.
+    ///
+    /// @return True if the file was parsed sucessfully, false if not.
     bool parseFile(const std::string& filespec);
-    
+
+    /// Accessors
+
+    /// \brief Get the port offset.
     int getPortOffset() { return _port_offset; };
+
+    // \brief Set the port offset
     void setPortOffset(int x) { _port_offset = x; };
 
+    /// \brief Get the number of file descriptors per thread.
     int getFDThread() { return _fdthread; };
+    /// \brief Set the number of file descriptors per thread.
     void setFDThread(int x) { _fdthread = x; };
 
+    /// \brief Get the special testing output option.
     bool getTestingFlag() { return _testing; };
+    /// \brief Set the special testing output option.
     void setTestingFlag(bool x) { _testing = x; };
-    
+
+    /// \brief Get the flag for whether to enable threading.
     bool getThreadingFlag() { return _threading; };
+    /// \brief Set the flag for whether to enable threading.
     void setThreadingFlag(bool x) { _threading = x; };
 
+    /// \brief Get the flag for whether to enable internal debugging messages.
     bool getNetDebugFlag() const { return _netdebug; }
+    /// \brief Set the flag for whether to enable internal debugging messages.
     void setNetDebugFlag(bool x) { _netdebug = x; }    
 
+    /// \brief Get the flag for whether to enable the administration thread.
     bool getAdminFlag() const { return _admin; }
+    /// \brief Set the  flag for whether to enable the administration thread.
     void setAdminFlag(bool x) { _admin = x; }
 
     ///  \brief Dump the internal data of this class in a human readable form.