summaryrefslogtreecommitdiffstats
path: root/ingen/client
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2012-05-11 06:05:58 +0000
committerDavid Robillard <d@drobilla.net>2012-05-11 06:05:58 +0000
commite5b2164c84d0928ce0765386095064fd946744c2 (patch)
tree861ad727d953b66f42652da17e607614a3ab7613 /ingen/client
parente684838068b6f8b37fe130195cdeb3a0f3b17ffd (diff)
downloadingen-e5b2164c84d0928ce0765386095064fd946744c2.tar.gz
ingen-e5b2164c84d0928ce0765386095064fd946744c2.tar.bz2
ingen-e5b2164c84d0928ce0765386095064fd946744c2.zip
Generate API documentation.
git-svn-id: http://svn.drobilla.net/lad/trunk/ingen@4352 a436a847-0d15-0410-975c-d299462d15a1
Diffstat (limited to 'ingen/client')
-rw-r--r--ingen/client/ClientStore.hpp2
-rw-r--r--ingen/client/EdgeModel.hpp2
-rw-r--r--ingen/client/NodeModel.hpp2
-rw-r--r--ingen/client/ObjectModel.hpp6
-rw-r--r--ingen/client/PatchModel.hpp2
-rw-r--r--ingen/client/PluginModel.hpp2
-rw-r--r--ingen/client/PluginUI.hpp2
-rw-r--r--ingen/client/PortModel.hpp2
-rw-r--r--ingen/client/SigClientInterface.hpp2
-rw-r--r--ingen/client/ThreadedSigClientInterface.hpp2
10 files changed, 16 insertions, 8 deletions
diff --git a/ingen/client/ClientStore.hpp b/ingen/client/ClientStore.hpp
index c212afcb..1512b941 100644
--- a/ingen/client/ClientStore.hpp
+++ b/ingen/client/ClientStore.hpp
@@ -48,7 +48,7 @@ class SigClientInterface;
/** Automatically manages models of objects in the engine.
*
- * \ingroup IngenClient
+ * @ingroup IngenClient
*/
class ClientStore : public Shared::Store
, public Interface
diff --git a/ingen/client/EdgeModel.hpp b/ingen/client/EdgeModel.hpp
index 41e1273c..9006dd80 100644
--- a/ingen/client/EdgeModel.hpp
+++ b/ingen/client/EdgeModel.hpp
@@ -32,7 +32,7 @@ class ClientStore;
/** Class to represent a port->port connections in the engine.
*
- * \ingroup IngenClient
+ * @ingroup IngenClient
*/
class EdgeModel : public Edge
{
diff --git a/ingen/client/NodeModel.hpp b/ingen/client/NodeModel.hpp
index 0184eacc..f56e4a54 100644
--- a/ingen/client/NodeModel.hpp
+++ b/ingen/client/NodeModel.hpp
@@ -42,7 +42,7 @@ class ClientStore;
/** Node model class, used by the client to store engine's state.
*
- * \ingroup IngenClient
+ * @ingroup IngenClient
*/
class NodeModel : public ObjectModel,
virtual public Ingen::Node
diff --git a/ingen/client/ObjectModel.hpp b/ingen/client/ObjectModel.hpp
index 9bddf4f8..1faf2e25 100644
--- a/ingen/client/ObjectModel.hpp
+++ b/ingen/client/ObjectModel.hpp
@@ -14,6 +14,10 @@
along with Ingen. If not, see <http://www.gnu.org/licenses/>.
*/
+/**
+ @defgroup IngenClient Client-Side Models and Utilities
+*/
+
#ifndef INGEN_CLIENT_OBJECTMODEL_HPP
#define INGEN_CLIENT_OBJECTMODEL_HPP
@@ -46,7 +50,7 @@ class ClientStore;
* well, it reduces Collection Hell) and wait for the result (as a signal
* from this Model).
*
- * \ingroup IngenClient
+ * @ingroup IngenClient
*/
class ObjectModel : virtual public GraphObject
, public Ingen::Shared::ResourceImpl
diff --git a/ingen/client/PatchModel.hpp b/ingen/client/PatchModel.hpp
index af5ecb2f..9d4e7752 100644
--- a/ingen/client/PatchModel.hpp
+++ b/ingen/client/PatchModel.hpp
@@ -33,7 +33,7 @@ class EdgeModel;
/** Client's model of a patch.
*
- * \ingroup IngenClient
+ * @ingroup IngenClient
*/
class PatchModel : public NodeModel, public Ingen::Patch
{
diff --git a/ingen/client/PluginModel.hpp b/ingen/client/PluginModel.hpp
index f7000065..395157ae 100644
--- a/ingen/client/PluginModel.hpp
+++ b/ingen/client/PluginModel.hpp
@@ -44,7 +44,7 @@ class PluginUI;
/** Model for a plugin available for loading.
*
- * \ingroup IngenClient
+ * @ingroup IngenClient
*/
class PluginModel : public Ingen::Plugin
, public Ingen::Shared::ResourceImpl
diff --git a/ingen/client/PluginUI.hpp b/ingen/client/PluginUI.hpp
index a4804b4c..25422fe8 100644
--- a/ingen/client/PluginUI.hpp
+++ b/ingen/client/PluginUI.hpp
@@ -37,7 +37,7 @@ class NodeModel;
/** Model for a plugin available for loading.
*
- * \ingroup IngenClient
+ * @ingroup IngenClient
*/
class PluginUI {
public:
diff --git a/ingen/client/PortModel.hpp b/ingen/client/PortModel.hpp
index 8065692d..477186fb 100644
--- a/ingen/client/PortModel.hpp
+++ b/ingen/client/PortModel.hpp
@@ -36,7 +36,7 @@ namespace Client {
/** Model of a port.
*
- * \ingroup IngenClient
+ * @ingroup IngenClient
*/
class PortModel : public ObjectModel, public Ingen::Port
{
diff --git a/ingen/client/SigClientInterface.hpp b/ingen/client/SigClientInterface.hpp
index dbc655dd..8b43bca0 100644
--- a/ingen/client/SigClientInterface.hpp
+++ b/ingen/client/SigClientInterface.hpp
@@ -36,6 +36,8 @@ namespace Client {
*
* The signals here match the calls to ClientInterface exactly. See the
* documentation for ClientInterface for meanings of signal parameters.
+ *
+ * @ingroup IngenClient
*/
class SigClientInterface : public Ingen::Interface,
public INGEN_TRACKABLE
diff --git a/ingen/client/ThreadedSigClientInterface.hpp b/ingen/client/ThreadedSigClientInterface.hpp
index e8b46504..71e1b2ee 100644
--- a/ingen/client/ThreadedSigClientInterface.hpp
+++ b/ingen/client/ThreadedSigClientInterface.hpp
@@ -46,6 +46,8 @@ namespace Client {
* functions are called. It must be explicitly driven with the emit_signals()
* function, which fires all enqueued signals up until the present. You can
* use this in a GTK idle callback for receiving thread safe engine signals.
+ *
+ * @ingroup IngenClient
*/
class ThreadedSigClientInterface : public SigClientInterface
{