Clean up code documentation.

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

4 files changed, 22 insertions, 27 deletions

diff --git a/src/server/BlockImpl.cpp b/src/server/BlockImpl.cpp
index ad5a233e..0cae55a2 100644
--- a/src/server/BlockImpl.cpp
+++ b/src/server/BlockImpl.cpp
@@ -144,8 +144,6 @@ BlockImpl::set_buffer_size(Context&       context,
 	}
 }
 
-/** Prepare to run a cycle (in the audio thread)
- */
 void
 BlockImpl::pre_process(ProcessContext& context)
 {
@@ -157,8 +155,6 @@ BlockImpl::pre_process(ProcessContext& context)
 	}
 }
 
-/** Prepare to run a cycle (in the audio thread)
- */
 void
 BlockImpl::post_process(ProcessContext& context)
 {
diff --git a/src/server/DuplexPort.cpp b/src/server/DuplexPort.cpp
index fe958e58..20f8f1b7 100644
--- a/src/server/DuplexPort.cpp
+++ b/src/server/DuplexPort.cpp
@@ -122,7 +122,6 @@ DuplexPort::max_tail_poly(Context& context) const
 	return parent_graph()->internal_poly_process();
 }
 
-/** Prepare for the execution of parent graph */
 void
 DuplexPort::pre_process(Context& context)
 {
@@ -141,7 +140,6 @@ DuplexPort::pre_process(Context& context)
 	}
 }
 
-/** Finalize after the execution of parent graph (deliver outputs) */
 void
 DuplexPort::post_process(Context& context)
 {
diff --git a/src/server/InputPort.cpp b/src/server/InputPort.cpp
index e8bb05cb..e0406f05 100644
--- a/src/server/InputPort.cpp
+++ b/src/server/InputPort.cpp
@@ -67,9 +67,6 @@ InputPort::apply_poly(ProcessContext& context, Raul::Maid& maid, uint32_t poly)
 	return true;
 }
 
-/** Set the buffers of `voices` to the buffers to be used for this port.
- * @return true iff buffers are locally owned by the port
- */
 bool
 InputPort::get_buffers(BufferFactory&      bufs,
                        Raul::Array<Voice>* voices,
@@ -106,25 +103,12 @@ InputPort::get_buffers(BufferFactory&      bufs,
 	return true;
 }
 
-/** Add an arc.  Realtime safe.
- *
- * The buffer of this port will be set directly to the arc's buffer
- * if there is only one arc, since no copying/mixing needs to take place.
- *
- * Note that setup_buffers must be called after this before the change
- * will audibly take effect.
- */
 void
 InputPort::add_arc(ProcessContext& context, ArcImpl* c)
 {
 	_arcs.push_front(*c);
 }
 
-/** Remove a arc.  Realtime safe.
- *
- * Note that setup_buffers must be called after this before the change
- * will audibly take effect.
- */
 ArcImpl*
 InputPort::remove_arc(ProcessContext& context, const OutputPort* tail)
 {
@@ -173,8 +157,6 @@ get_sources(const Context& context,
 	}
 }
 
-/** Prepare buffer for access, mixing if necessary.  Realtime safe.
- */
 void
 InputPort::pre_process(Context& context)
 {
diff --git a/src/server/InputPort.hpp b/src/server/InputPort.hpp
index da0d9327..12d28b04 100644
--- a/src/server/InputPort.hpp
+++ b/src/server/InputPort.hpp
@@ -69,18 +69,37 @@ public:
 	/** Return the maximum polyphony of an output connected to this input. */
 	virtual uint32_t max_tail_poly(Context& context) const;
 
-	void     add_arc(ProcessContext& context, ArcImpl* c);
+	bool apply_poly(ProcessContext& context, Raul::Maid& maid, uint32_t poly);
+
+	/** Add an arc.  Realtime safe.
+	 *
+	 * The buffer of this port will be set directly to the arc's buffer
+	 * if there is only one arc, since no copying/mixing needs to take place.
+	 *
+	 * setup_buffers() must be called later for the change to take effect.
+	 */
+	void add_arc(ProcessContext& context, ArcImpl* c);
+
+	/** Remove an arc.  Realtime safe.
+	 *
+	 * setup_buffers() must be called later for the change to take effect.
+	 */
 	ArcImpl* remove_arc(ProcessContext&   context,
 	                    const OutputPort* tail);
 
-	bool apply_poly(ProcessContext& context, Raul::Maid& maid, uint32_t poly);
-
+	/** Set `voices` as the buffers to be used for this port.
+	 *
+	 * @return true iff buffers are locally owned by the port
+	 */
 	bool get_buffers(BufferFactory&      bufs,
 	                 Raul::Array<Voice>* voices,
 	                 uint32_t            poly,
 	                 bool                real_time) const;
 
+	/** Prepare buffer for access, mixing if necessary. */
 	void pre_process(Context& context);
+
+	/** Prepare buffer for next process cycle. */
 	void post_process(Context& context);
 
 	size_t num_arcs() const { return _num_arcs; } ///< Pre-process thread