Loads of updates to several systems, see each for what really changed, the

biggest are the updates to the exception framework, and to the pproc system,
which is almost a competitor to popt already...

1 files changed, 48 insertions, 2 deletions

diff --git a/src/exception.h b/src/exception.h
index be876d7..2233736 100644
--- a/src/exception.h
+++ b/src/exception.h
@@ -3,20 +3,66 @@
 
 #include <string>
 #include <exception>
+#include <stdarg.h>
 
+/**
+ * A generalized Exception base class.  This is nice for making general and
+ * flexible child classes that can create new error code classes.
+ */
 class Exception : public std::exception
 {
 public:
+        /**
+         * Construct an exception with an error code of zero, but with a
+         * description.  The use of this is not reccomended most of the time, it's
+         * generally best to include an error code with the exception so your
+         * program can handle the exception in a better way.
+         * @param sFormat The format of the text.  See printf for more info.
+         */
         Exception( const char *sFormat, ... ) throw();
+        
+        /**
+         * 
+         * @param nCode 
+         * @param sFormat
+         */
         Exception( int nCode, const char *sFormat, ... ) throw();
+        
+        /**
+         * 
+         * @param nCode 
+         * @return 
+         */
+        Exception( int nCode=0 ) throw();
+        
+        /**
+         * 
+         * @return 
+         */
         virtual ~Exception() throw();
 
+        /**
+         * 
+         * @return 
+         */
         virtual const char *what() const throw();
+        
+        /**
+         * 
+         * @return 
+         */
         int getErrorCode();
+        
+        /**
+         * 
+         * @param lpFormat 
+         * @param vargs 
+         */
+        void setWhat( const char *lpFormat, va_list &vargs );
 
 private:
-        char *sWhat;
-        int nErrorCode;
+        char *sWhat;    /**< The text string telling people what went wrong. */
+        int nErrorCode; /**< The code for the error that occured. */
 };
 
 #endif