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, 21 insertions, 1 deletions

diff --git a/src/serializable.h b/src/serializable.h
index 36c94df..06def29 100644
--- a/src/serializable.h
+++ b/src/serializable.h
@@ -3,12 +3,32 @@
 
 //#include "serializer.h"
 
+/**
+ * The base class for any class you want to serialize.  Simply include this as
+ * a base class, implement the purely virtual serialize function and you've got
+ * an easily serializable class.
+ */
 class Serializable
 {
 public:
+        /**
+         * Does nothing, here for completeness.
+         */
         Serializable();
+
+        /**
+         * Here to ensure the deconstructor is virtual.
+         */
         virtual ~Serializable();
-        virtual void serialize(class Serializer &)=0;
+
+        /**
+         * This is the main workhorse of the serialization system, just override and
+         * you've got a serializable class.  A reference to the Serializer archive
+         * used is passed in as your only parameter, query it to discover if you are
+         * loading or saving.
+         * @param ar A reference to the Serializer object to use.
+         */
+        virtual void serialize( class Serializer &ar )=0;
 };
 
 #endif