comments and other minor stuff

1 files changed, 31 insertions, 18 deletions

diff --git a/src/Resource.hh b/src/Resource.hh
index 10a77f7..8055701 100644
--- a/src/Resource.hh
+++ b/src/Resource.hh
@@ -19,7 +19,7 @@
 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 // DEALINGS IN THE SOFTWARE.
 
-// $Id: Resource.hh,v 1.5 2002/05/17 10:59:58 fluxgen Exp $
+// $Id: Resource.hh,v 1.6 2002/07/20 09:51:03 fluxgen Exp $
 
 #ifndef RESOURCE_HH
 #define RESOURCE_HH
@@ -31,23 +31,29 @@
 class Resource_base:private NotCopyable
 {
 public:
-
-        virtual void setFromString(char const *strval)=0;
-        virtual void setDefaultValue()=0;
-        
-        virtual std::string getString()=0;
-        inline const std::string& getAltName() const { return m_altname; }
-        inline const std::string& getName() const { return m_name; }
+        virtual ~Resource_base() { };   
         
+        /// set from string value
+        virtual void setFromString(char const *strval) = 0;
+        /// set default value
+        virtual void setDefaultValue() = 0;
+        /// get string value
+        virtual std::string getString() = 0;
+        /// get alternative name of this resource
+        inline const std::string& altName() const { return m_altname; }
+        /// get name of this resource
+        inline const std::string& name() const { return m_name; }
+
 protected:      
         Resource_base(const std::string &name, const std::string &altname):
         m_name(name), m_altname(altname)
         {
         
         }
-        virtual ~Resource_base(){       };
+
 private:
-        std::string m_name, m_altname;
+        std::string m_name; // name of this resource
+        std::string m_altname; // alternative name 
 };
 
 class ResourceManager;
@@ -62,10 +68,10 @@ public:
         m_value(val), m_defaultval(val),
         m_rm(rm)
         {
-                m_rm.addResource(*this);
+                m_rm.addResource(*this); // add this to resource handler
         }
-        ~Resource() {
-                m_rm.removeResource(*this);
+        virtual ~Resource() {
+                m_rm.removeResource(*this); // remove this from resource handler
         }
 
         inline void setDefaultValue() {  m_value = m_defaultval; }
@@ -87,10 +93,16 @@ class ResourceManager
 public:
         typedef std::list<Resource_base *> ResourceList;
 
-        ResourceManager(){ }    
-        
-        bool load(const char *filename);
-        bool save(const char *filename, const char *mergefilename=0);
+        ResourceManager() { }
+        virtual ~ResourceManager() {}
+        /**
+                load all resouces registered to this class
+        */
+        virtual bool load(const char *filename);
+        /**
+                save all resouces registered to this class
+        */
+        virtual bool save(const char *filename, const char *mergefilename=0);
         template <class T>
         void addResource(Resource<T> &r) {
                 m_resourcelist.push_back(&r);
@@ -100,8 +112,9 @@ public:
         void removeResource(Resource<T> &r) {
                 m_resourcelist.remove(&r);
         }
-private:
+protected:
         static inline void ensureXrmIsInitialize();
+private:
         static bool m_init;
         ResourceList m_resourcelist;