diff options
author | David Robillard <d@drobilla.net> | 2009-05-27 19:48:44 +0000 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2009-05-27 19:48:44 +0000 |
commit | aad41d097d9d4e3aff25616f86fa3a77653a10d1 (patch) | |
tree | 8562c9270fad44a01d8011d38ec146af6d46a515 /src/engine/events/DeleteEvent.hpp | |
parent | 0c1576d21588ece4e226da04523f36adac3a14c3 (diff) | |
download | ingen-aad41d097d9d4e3aff25616f86fa3a77653a10d1.tar.gz ingen-aad41d097d9d4e3aff25616f86fa3a77653a10d1.tar.bz2 ingen-aad41d097d9d4e3aff25616f86fa3a77653a10d1.zip |
Add methods documentation page.
Clean up OSC documentation pages.
git-svn-id: http://svn.drobilla.net/lad/trunk/ingen@2013 a436a847-0d15-0410-975c-d299462d15a1
Diffstat (limited to 'src/engine/events/DeleteEvent.hpp')
-rw-r--r-- | src/engine/events/DeleteEvent.hpp | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/src/engine/events/DeleteEvent.hpp b/src/engine/events/DeleteEvent.hpp index d0fa43f1..05c47325 100644 --- a/src/engine/events/DeleteEvent.hpp +++ b/src/engine/events/DeleteEvent.hpp @@ -36,10 +36,19 @@ class DriverPort; class DisconnectAllEvent; class CompiledPatch; - -/** Delete a graph object. - * WebDAV method DELETE (RFC4918 S9.6). +/** \page methods + * <h2>DELETE</h2> + * From WebDAV (RFC4918 S9.6). + * + * Calling DELETE on an object will remove that object from the engine + * (i.e. stop executing it) and destroy it. * + * \li All properties of the object are lost + * \li All references to the object are lost (e.g. the parent's reference to + * this child is lost, any connections to the object are removed, etc.) + */ + +/** DELETE a graph object (see \ref methods). * \ingroup engine */ class DeleteEvent : public QueuedEvent |