From 38761ec2b70605e7ad126691075a448a357db912 Mon Sep 17 00:00:00 2001
From: David Robillard <d@drobilla.net>
Date: Thu, 2 Oct 2008 05:16:25 +0000
Subject: Make --build-docs at configure time trigger documentation building at
build time.
git-svn-id: http://svn.drobilla.net/lad/trunk/ingen@1589 a436a847-0d15-0410-975c-d299462d15a1
---
src/client/DeprecatedLoader.cpp | 1 -
src/engine/AudioBuffer.hpp | 2 +-
src/engine/PortImpl.hpp | 2 +-
src/engine/QueuedEngineInterface.hpp | 14 ++------------
src/gui/Port.cpp | 2 +-
src/serialisation/Parser.cpp | 3 ---
6 files changed, 5 insertions(+), 19 deletions(-)
(limited to 'src')
diff --git a/src/client/DeprecatedLoader.cpp b/src/client/DeprecatedLoader.cpp
index a07893f7..2b4e34a4 100644
--- a/src/client/DeprecatedLoader.cpp
+++ b/src/client/DeprecatedLoader.cpp
@@ -202,7 +202,6 @@ DeprecatedLoader::add_variable(GraphObject::Variables& data, string old_key, str
* to the root patch)
*
* @param name Name of this patch (loaded/generated if the empty string)
- * @param poly Polyphony of this patch (loaded/generated if 0)
*
* @param initial_data will be set last, so values passed there will override
* any values loaded from the patch file.
diff --git a/src/engine/AudioBuffer.hpp b/src/engine/AudioBuffer.hpp
index 513c188f..b93e2267 100644
--- a/src/engine/AudioBuffer.hpp
+++ b/src/engine/AudioBuffer.hpp
@@ -74,7 +74,7 @@ private:
size_t _size; ///< Allocated buffer size
size_t _filled_size; ///< Usable buffer size (for MIDI ports etc)
State _state; ///< State of buffer for setting values next cycle
- Sample _set_value; ///< Value set by @ref set (may need to be set next cycle)
+ Sample _set_value; ///< Value set by set_value (for completing the set next cycle)
FrameTime _set_time; ///< Time _set_value was set (to reset next cycle)
};
diff --git a/src/engine/PortImpl.hpp b/src/engine/PortImpl.hpp
index be96a910..a2eaf2c9 100644
--- a/src/engine/PortImpl.hpp
+++ b/src/engine/PortImpl.hpp
@@ -65,7 +65,7 @@ public:
*
* Audio thread.
*
- * \param poly Must be < the most recent value passed to prepare_poly.
+ * \a poly Must be < the most recent value passed to prepare_poly.
*/
virtual bool apply_poly(Raul::Maid& maid, uint32_t poly);
diff --git a/src/engine/QueuedEngineInterface.hpp b/src/engine/QueuedEngineInterface.hpp
index 73c790c8..89810434 100644
--- a/src/engine/QueuedEngineInterface.hpp
+++ b/src/engine/QueuedEngineInterface.hpp
@@ -41,20 +41,10 @@ class Engine;
* This is the bridge between the EngineInterface presented to the client, and
* the EventSource that needs to be presented to the AudioDriver.
*
- * This is sort of a state machine, \ref set_responder sets the Responder that
- * will be used to send the response from all future function calls. Stateless
- * protocols like UDP/OSC can use this to set a different response address for
- * each event (eg incoming UDP port), but engine/client interfaces that don't
- * need to change an 'address' constantly can just set it once on initialisation.
- * Blocking control interfaces can be made by setting a Responder which signals
- * the caller when the 'response' is 'sent'.
- *
+ * Responses occur through the event mechanism (which notified clients in
+ * event post_process methods) and are related to an event by an integer ID.
* If you do not register a responder, you have no way of knowing if your calls
* are successful.
- *
- * FIXME: this isn't really "queued" entirely, since some events aren't queued
- * events and get pushed directly into the realtime event queue. Should that
- * be separated into a different interface/client?
*/
class QueuedEngineInterface : public QueuedEventSource, public EngineInterface
{
diff --git a/src/gui/Port.cpp b/src/gui/Port.cpp
index 031c74c5..38db6d25 100644
--- a/src/gui/Port.cpp
+++ b/src/gui/Port.cpp
@@ -34,7 +34,7 @@ namespace Ingen {
namespace GUI {
-/** @param flip Make an input port appear as an output port, and vice versa.
+/** @a flip Make an input port appear as an output port, and vice versa.
*/
Port::Port(
boost::shared_ptr<FlowCanvas::Module> module,
diff --git a/src/serialisation/Parser.cpp b/src/serialisation/Parser.cpp
index aed49a38..3eae4814 100644
--- a/src/serialisation/Parser.cpp
+++ b/src/serialisation/Parser.cpp
@@ -52,9 +52,6 @@ Parser::uri_relative_to_base(Glib::ustring base, const Glib::ustring uri)
/** Parse a patch from RDF into a CommonInterface (engine or client).
- *
- * @param document_uri URI of file to load objects from.
- * @param parent Path of parent under which to load objects.
* @return whether or not load was successful.
*/
bool
--
cgit v1.2.1