diff options
author | Robin Gareus <robin@gareus.org> | 2017-04-16 17:26:58 +0200 |
---|---|---|
committer | Robin Gareus <robin@gareus.org> | 2017-04-16 17:26:58 +0200 |
commit | 2e1a884d6ea025e6a6402e013b1a68f13d9578a2 (patch) | |
tree | 522275467a2e3e0eee60e9c12c7c660fdcb9d5db /libs/pbd | |
parent | 67f2e4b866ddd3953b85eaadf545647e67730c39 (diff) |
Fix Doxygen syntax (amend/revert f1a4767ac)
1st line after /** brief description.
Doxygen is used for Ardour's online source doc and the Lua class reference.
Diffstat (limited to 'libs/pbd')
-rw-r--r-- | libs/pbd/pbd/property_list.h | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/libs/pbd/pbd/property_list.h b/libs/pbd/pbd/property_list.h index 7bc3752d4e..c43c160684 100644 --- a/libs/pbd/pbd/property_list.h +++ b/libs/pbd/pbd/property_list.h @@ -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. |