ardour/livetrax
13
0
Fork 0
Code

Fix Doxygen syntax (amend/revert f1a4767ac)

Browse Source 
1st line after /**  brief description.
Doxygen is used for Ardour's online source doc and the Lua class reference.
This commit is contained in:
Robin Gareus 2017-04-16 17:26:58 +02:00
parent 67f2e4b866
commit 2e1a884d6e
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
libs/pbd/pbd/property_list.h
View File

@ -41,12 +41,16 @@ public:
void get_changes_as_xml (XMLNode*); void get_changes_as_xml (XMLNode*);
void invert (); 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. * constructing PropertyLists that describe a change/operation.
*/ */
bool add (PropertyBase* prop); 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. * in setting the state of an object uses this.
* *
* Defined below, once we have Property<T> * Defined below, once we have Property<T>
@ -57,7 +61,9 @@ protected:
bool _property_owner; 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 * property list in its destructor. Objects with their
* own Properties store them in an OwnedPropertyList * own Properties store them in an OwnedPropertyList
* to avoid having them deleted at the wrong time. * to avoid having them deleted at the wrong time.
@ -67,7 +73,9 @@ class LIBPBD_API OwnedPropertyList : public PropertyList
public: public:
OwnedPropertyList(); 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 * property members to their plists. Note that it takes
* a reference argument rather than a pointer like * a reference argument rather than a pointer like
* one of the add() methods in PropertyList. * one of the add() methods in PropertyList.