From 2d90647f9f6f36ac424a6b8f2e86e110eb0c5fd2 Mon Sep 17 00:00:00 2001
From: David Robillard <d@drobilla.net>
Date: Wed, 27 May 2009 20:20:40 +0000
Subject: Documentation.

git-svn-id: http://svn.drobilla.net/lad/trunk/ingen@2014 a436a847-0d15-0410-975c-d299462d15a1
---
 src/engine/Event.cpp              | 28 ++++++++++++++++++++++++++++
 src/engine/events/DeleteEvent.hpp |  5 ++---
 src/engine/events/MoveEvent.hpp   |  6 +++---
 3 files changed, 33 insertions(+), 6 deletions(-)

(limited to 'src')

diff --git a/src/engine/Event.cpp b/src/engine/Event.cpp
index e48d32a2..f79c975a 100644
--- a/src/engine/Event.cpp
+++ b/src/engine/Event.cpp
@@ -26,6 +26,34 @@
  * HTTP and WebDAV standards as closely as possible.</p>
  */
 
+
+/** \page methods
+ * <h2>POST</h2>
+ * As per HTTP (RFC2616 S9.5).
+ *
+ * Append properties to a graph object.
+ *
+ * An object can have several properties with a single predicate.
+ * POST appends properties without modifying or removing existing properties.
+ */
+
+
+/** \page methods
+ * <h2>PUT</h2>
+ * As per HTTP (RFC2616 S9.6).
+ *
+ * Set properties of a graph object, or create an object.
+ *
+ * An object can have several properties with a single predicate.
+ * \li If the object does not yet exist, the message must contain sufficient
+ * information to create the object (e.g. known rdf:type properties, etc.)
+ * \li If the object does exist, a PUT removes all existing object properties
+ * with predicates that match any property in the message, then adds all
+ * properties from the message.
+ */
+
+
+
 namespace Ingen {
 
 
diff --git a/src/engine/events/DeleteEvent.hpp b/src/engine/events/DeleteEvent.hpp
index 05c47325..abaf9cdd 100644
--- a/src/engine/events/DeleteEvent.hpp
+++ b/src/engine/events/DeleteEvent.hpp
@@ -38,10 +38,9 @@ class CompiledPatch;
 
 /** \page methods
  * <h2>DELETE</h2>
- * From WebDAV (RFC4918 S9.6).
+ * As per WebDAV (RFC4918 S9.6).
  *
- * Calling DELETE on an object will remove that object from the engine
- * (i.e. stop executing it) and destroy it.
+ * Remove an object from the engine 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
diff --git a/src/engine/events/MoveEvent.hpp b/src/engine/events/MoveEvent.hpp
index 7b77439f..06b410fb 100644
--- a/src/engine/events/MoveEvent.hpp
+++ b/src/engine/events/MoveEvent.hpp
@@ -28,10 +28,10 @@ class PatchImpl;
 
 /** \page methods
  * <h2>MOVE</h2>
- * From WebDAV (RFC4918 S9.9).
+ * As per WebDAV (RFC4918 S9.9).
  *
- * Calling MOVE on an object removes it from its current location
- * and inserts it at a new one in a single operation.
+ * Move an object from its current location and insert it at a new location
+ * in a single operation.
  *
  * MOVE to a path with a different parent is currently not supported.
  */
-- 
cgit v1.2.1