Fix Doxygen syntax (amend/revert f1a4767ac)
authorRobin Gareus <robin@gareus.org>
Sun, 16 Apr 2017 15:26:58 +0000 (17:26 +0200)
committerRobin Gareus <robin@gareus.org>
Sun, 16 Apr 2017 15:26:58 +0000 (17:26 +0200)
1st line after /**  brief description.
Doxygen is used for Ardour's online source doc and the Lua class reference.

libs/pbd/pbd/property_list.h

index 7bc3752d4ecd169ebfc1f11af3e17097b8c8b7ef..c43c160684109bdc98f0f50851e3d15bec368c7c 100644 (file)
@@ -41,12 +41,16 @@ public:
        void get_changes_as_xml (XMLNode*);
        void invert ();
 
-       /* Add a property (of some kind) to the list. Used when
+       /** 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>
@@ -57,7 +61,9 @@ protected:
        bool _property_owner;
 };
 
-/* A variant of PropertyList that does not delete its
+/** 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.
@@ -67,7 +73,9 @@ 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.