Clean up Machine documentation.

git-svn-id: http://svn.drobilla.net/lad/trunk/machina@5000 a436a847-0d15-0410-975c-d299462d15a1

1 files changed, 7 insertions, 3 deletions

diff --git a/src/engine/machina/Machine.hpp b/src/engine/machina/Machine.hpp
index cd94391..d712c33 100644
--- a/src/engine/machina/Machine.hpp
+++ b/src/engine/machina/Machine.hpp
@@ -65,8 +65,7 @@ public:
 
 	void write_state(Sord::Model& model);
 
-	/** Exit all active nodes and reset time to 0.
-	 */
+	/** Exit all active nodes and reset time to 0. */
 	void reset(MIDISink* sink, Raul::TimeStamp time);
 
 	/** Run the machine for a (real) time slice.
@@ -98,15 +97,20 @@ public:
 	float fitness;  // For GA
 
 private:
-	// Audio context
+	/** Return the active Node with the earliest exit time. */
 	SPtr<Node> earliest_node() const;
 
 	void assign(const Machine& other);
 
+	/** Enter a node at the current time (called by run()).
+	 *
+	 * @return true if node was entered, otherwise voics are exhausted.
+	 */
 	bool enter_node(Context&               context,
 	                SPtr<Node>             node,
 	                SPtr<Raul::RingBuffer> updates);
 
+	/** Exit a node at the current time (called by run()). */
 	void exit_node(Context&               context,
 	               SPtr<Node>             node,
 	               SPtr<Raul::RingBuffer> updates);