diff options
| author | David Robillard <d@drobilla.net> | 2014-08-08 06:12:09 +0000 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2014-08-08 06:12:09 +0000 |
| commit | ea8f653960d5b3a1fe6012f57cbfadd85a1ef68c (patch) | |
| tree | 466269e08896b753698f2bccc5ab3bb87b03d48f /ingen/Store.hpp | |
| parent | e7edb3e68c29b3801911d9f77210b8e2f2cd1caf (diff) | |
| download | ingen-ea8f653960d5b3a1fe6012f57cbfadd85a1ef68c.tar.gz ingen-ea8f653960d5b3a1fe6012f57cbfadd85a1ef68c.tar.bz2 ingen-ea8f653960d5b3a1fe6012f57cbfadd85a1ef68c.zip | |
Use Markdown in doc comments for better source readability.
git-svn-id: http://svn.drobilla.net/lad/trunk/ingen@5428 a436a847-0d15-0410-975c-d299462d15a1
Diffstat (limited to 'ingen/Store.hpp')
| -rw-r--r-- | ingen/Store.hpp | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/ingen/Store.hpp b/ingen/Store.hpp index dcab2532..33a7f2ea 100644 --- a/ingen/Store.hpp +++ b/ingen/Store.hpp @@ -53,16 +53,18 @@ public: const_range children_range(SPtr<const Node> o) const; - /** Remove the object at @p top and all its children from the store. + /** Remove the object at `top` and all its children from the store. + * + * @param top Iterator to first (topmost parent) object to remove. * * @param removed Filled with all the removed objects. Note this may be * many objects since any children will be removed as well. */ void remove(iterator top, Objects& removed); - /** Rename (move) the object at @p top to @p new_path. + /** Rename (move) the object at `top` to `new_path`. * - * Note this invalidates @p i. + * Note this invalidates `i`. */ void rename(iterator i, const Raul::Path& new_path); |