[Gnash-commit] /srv/bzr/gnash/rtmp r9693: Finish up doxygen comnments.

[rob]

------------------------------------------------------------
revno: 9693
committer: address@hidden
branch nick: rtmp
timestamp: Mon 2008-11-03 12:27:59 -0700
message:
  Finish up doxygen comnments.
modified:
  cygnal/crc.cpp

=== modified file 'cygnal/crc.cpp'
--- a/cygnal/crc.cpp    2008-11-03 01:01:42 +0000
+++ b/cygnal/crc.cpp    2008-11-03 19:27:59 +0000
@@ -44,8 +44,11 @@
 using namespace std;
 using namespace gnash;
 
+/// \namespace cygnal
+///    This namespace is for all the Cygnal specific classes.
 namespace cygnal {
 
+/// \brief Return the default instance of RC file,
 CRcInitFile&
 CRcInitFile::getDefaultInstance()
 {
@@ -73,7 +76,12 @@
 //    GNASH_REPORT_FUNCTION;    
 }
 
-// Look for a config file in the likely places.
+/// \brief Load all the configuration files.
+///    This includes parsing the default .gnashrc file for
+///    Gnash settings that control the swf parser and virtual
+///    machine. These setting can be overridden in the
+///    .cygnalrc file, plus the Cygnal specific file has
+///    options only used by Cygnal.
 bool
 CRcInitFile::loadFiles()
 {
@@ -105,8 +113,11 @@
     return false;
 }
 
-
-// Parse the config file and set the variables.
+/// \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
 CRcInitFile::parseFile(const std::string& filespec)
 {
@@ -219,6 +230,8 @@
     return true;
 }
 
+/// \brief Dump the internal data of this class in a human readable form.
+/// @remarks This should only be used for debugging purposes.
 void
 CRcInitFile::dump(std::ostream& os) const
 {