Use XMLNode::set_property in PBD::PropertyTemplate<T> class
[ardour.git] / libs / pbd / pbd / property_list.h
index abb85e77d52dbd1940dd60cd9be11c2097e39517..c43c160684109bdc98f0f50851e3d15bec368c7c 100644 (file)
@@ -29,27 +29,31 @@ class XMLNode;
 
 namespace PBD {
 
-/** A list of properties, mapped using their ID */     
+/** A list of properties, mapped using their ID */
 class LIBPBD_API PropertyList : public std::map<PropertyID, PropertyBase*>
 {
 public:
        PropertyList ();
        PropertyList (PropertyList const &);
-        
+
        virtual ~PropertyList();
 
-        void get_changes_as_xml (XMLNode *);
+       void get_changes_as_xml (XMLNode*);
        void invert ();
 
-        /** Add a property (of some kind) to the list. Used when
-            constructing PropertyLists that describe a change/operation.
-        */
-        bool add (PropertyBase* prop);
+       /** Add a property (of some kind) to the list.
+        *
+        * Used when
+        * constructing PropertyLists that describe a change/operation.
+        */
+       bool add (PropertyBase* prop);
 
-       /* Code that is constructing a property list for use
+       /** Construct a new Property List
+        *
+        * Code that is constructing a property list for use
         * in setting the state of an object uses this.
-         *
-         * Defined below, once we have Property<T>
+        *
+        * Defined below, once we have Property<T>
         */
        template<typename T, typename V> bool add (PropertyDescriptor<T> pid, const V& v);
 
@@ -57,20 +61,24 @@ protected:
        bool _property_owner;
 };
 
-/** A variant of PropertyList that does not delete its
- *  property list in its destructor. Objects with their
- *  own Properties store them in an OwnedPropertyList
- *  to avoid having them deleted at the wrong time.
+/** Persistent Property List
+ *
+ * A variant of PropertyList that does not delete its
+ * property list in its destructor. Objects with their
+ * own Properties store them in an OwnedPropertyList
+ * to avoid having them deleted at the wrong time.
  */
 class LIBPBD_API OwnedPropertyList : public PropertyList
 {
 public:
        OwnedPropertyList();
 
-       /* Classes that own property lists use this to add their
+       /** Add a property to the List
+        *
+        * Classes that own property lists use this to add their
         * property members to their plists. Note that it takes
-         * a reference argument rather than a pointer like
-         * one of the add() methods in PropertyList.
+        * a reference argument rather than a pointer like
+        * one of the add() methods in PropertyList.
         */
        bool add (PropertyBase& p);
 };