Generate API documentation.

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

14 files changed, 44 insertions, 12 deletions

diff --git a/ingen/shared/AtomReader.hpp b/ingen/shared/AtomReader.hpp
index 7e8cd93f..2887aad1 100644
--- a/ingen/shared/AtomReader.hpp
+++ b/ingen/shared/AtomReader.hpp
@@ -29,7 +29,9 @@ class AtomSink;
 class Forge;
 class URIMap;
 
-/** An AtomSink that calls methods on an Interface. */
+/** An AtomSink that calls methods on an Interface.
+ * @ingroup IngenShared
+ */
 class AtomReader : public AtomSink
 {
 public:
diff --git a/ingen/shared/AtomSink.hpp b/ingen/shared/AtomSink.hpp
index c156d3cd..b4694926 100644
--- a/ingen/shared/AtomSink.hpp
+++ b/ingen/shared/AtomSink.hpp
@@ -22,6 +22,9 @@
 namespace Ingen {
 namespace Shared {
 
+/** A sink for LV2 Atoms.
+ * @ingroup IngenShared
+ */
 class AtomSink {
 public:
 	virtual ~AtomSink() {}
diff --git a/ingen/shared/AtomWriter.hpp b/ingen/shared/AtomWriter.hpp
index cdf0660a..585c362a 100644
--- a/ingen/shared/AtomWriter.hpp
+++ b/ingen/shared/AtomWriter.hpp
@@ -30,7 +30,7 @@ namespace Shared {
 class AtomSink;
 class URIMap;
 
-/** An Interface that writes LV2 atoms. */
+/** An Interface that writes LV2 atoms to an AtomSink. */
 class AtomWriter : public Interface
 {
 public:
diff --git a/ingen/shared/Builder.hpp b/ingen/shared/Builder.hpp
index 8a800ca6..11804330 100644
--- a/ingen/shared/Builder.hpp
+++ b/ingen/shared/Builder.hpp
@@ -28,7 +28,7 @@ class URIs;
 
 /** Wrapper for Interface to create existing objects/models.
  *
- * \ingroup interface
+ * @ingroup IngenShared
  */
 class Builder
 {
diff --git a/ingen/shared/ClashAvoider.hpp b/ingen/shared/ClashAvoider.hpp
index 77be091e..40b1bdb6 100644
--- a/ingen/shared/ClashAvoider.hpp
+++ b/ingen/shared/ClashAvoider.hpp
@@ -36,6 +36,8 @@ class Store;
 
 /** A wrapper for an Interface that creates objects but possibly maps
  * symbol names to avoid clashes with the existing objects in a store.
+ *
+ * @ingroup IngenShared
  */
 class ClashAvoider : public Interface
 {
diff --git a/ingen/shared/Configuration.hpp b/ingen/shared/Configuration.hpp
index d3c975c5..211184d0 100644
--- a/ingen/shared/Configuration.hpp
+++ b/ingen/shared/Configuration.hpp
@@ -22,6 +22,9 @@
 namespace Ingen {
 namespace Shared {
 
+/** Ingen configuration (command line options).
+ * @ingroup IngenShared
+ */
 class Configuration : public Raul::Configuration {
 public:
 	Configuration();
diff --git a/ingen/shared/Forge.hpp b/ingen/shared/Forge.hpp
index f9d225cd..1d820bc0 100644
--- a/ingen/shared/Forge.hpp
+++ b/ingen/shared/Forge.hpp
@@ -26,6 +26,9 @@ namespace Shared {
 
 class URIMap;
 
+/** Forge for Raul Atoms.
+ * @ingroup IngenShared
+ */
 class Forge : public Raul::Forge {
 public:
 	explicit Forge(Shared::URIMap& map);
diff --git a/ingen/shared/LV2Features.hpp b/ingen/shared/LV2Features.hpp
index 2ced50a1..c2a6021d 100644
--- a/ingen/shared/LV2Features.hpp
+++ b/ingen/shared/LV2Features.hpp
@@ -31,7 +31,8 @@ namespace Shared {
 
 class World;
 
-/** Stuff that may need to be passed to an LV2 plugin (i.e. LV2 features).
+/** Features for use by LV2 plugins.
+ * @ingroup IngenShared
  */
 class LV2Features {
 public:
diff --git a/ingen/shared/Module.hpp b/ingen/shared/Module.hpp
index 73759786..1552a225 100644
--- a/ingen/shared/Module.hpp
+++ b/ingen/shared/Module.hpp
@@ -29,6 +29,7 @@ class World;
 /** A dynamically loaded Ingen module.
  *
  * All components of Ingen reside in one of these.
+ * @ingroup IngenShared
  */
 struct Module {
 	virtual ~Module();
diff --git a/ingen/shared/ResourceImpl.hpp b/ingen/shared/ResourceImpl.hpp
index b4d024d4..157c0365 100644
--- a/ingen/shared/ResourceImpl.hpp
+++ b/ingen/shared/ResourceImpl.hpp
@@ -27,6 +27,9 @@ namespace Shared {
 
 class URIs;
 
+/** Implementation of a Resource.
+ * @ingroup IngenShared
+ */
 class ResourceImpl : virtual public Resource
 {
 public:
diff --git a/ingen/shared/Store.hpp b/ingen/shared/Store.hpp
index 081d7fae..af281b9a 100644
--- a/ingen/shared/Store.hpp
+++ b/ingen/shared/Store.hpp
@@ -29,6 +29,9 @@
 namespace Ingen {
 namespace Shared {
 
+/** Store of objects in the patch hierarchy.
+ * @ingroup IngenShared
+ */
 class Store : public Raul::PathTable< SharedPtr<GraphObject> > {
 public:
 	virtual ~Store() {}
diff --git a/ingen/shared/URIMap.hpp b/ingen/shared/URIMap.hpp
index 1e8fb452..952d67ce 100644
--- a/ingen/shared/URIMap.hpp
+++ b/ingen/shared/URIMap.hpp
@@ -20,17 +20,18 @@
 #include <map>
 #include <utility>
 
-#include <boost/utility.hpp>
-
 #include "ingen/shared/LV2Features.hpp"
 #include "lv2/lv2plug.in/ns/ext/urid/urid.h"
 #include "raul/URI.hpp"
+#include "raul/Noncopyable.hpp"
 
 namespace Ingen {
 namespace Shared {
 
-/** URI to Integer Map */
-class URIMap : public boost::noncopyable {
+/** URI to integer map and implementation of LV2 URID extension.
+ * @ingroup IngenShared
+ */
+class URIMap : public Raul::Noncopyable {
 public:
 	URIMap(LV2_URID_Map* map, LV2_URID_Unmap* unmap);
 	virtual ~URIMap() {}
diff --git a/ingen/shared/URIs.hpp b/ingen/shared/URIs.hpp
index f724d81d..545a2bf0 100644
--- a/ingen/shared/URIs.hpp
+++ b/ingen/shared/URIs.hpp
@@ -17,11 +17,10 @@
 #ifndef INGEN_SHARED_URIS_HPP
 #define INGEN_SHARED_URIS_HPP
 
-#include <boost/utility.hpp>
-
 #include "ingen/shared/Forge.hpp"
 #include "lv2/lv2plug.in/ns/ext/urid/urid.h"
 #include "raul/Atom.hpp"
+#include "raul/Noncopyable.hpp"
 #include "raul/URI.hpp"
 
 namespace Raul {
@@ -33,7 +32,15 @@ namespace Shared {
 
 class URIMap;
 
-class URIs : public boost::noncopyable {
+/** Frequently used interned URIs.
+ *
+ * This class initially maps all the special URIs used throughout the code
+ * using the URIMap so they can be used quickly with the performance of
+ * integers, but still be dynamic.
+ *
+ * @ingroup IngenShared
+ */
+class URIs : public Raul::Noncopyable {
 public:
 	URIs(Ingen::Shared::Forge& forge, URIMap* map);
 
diff --git a/ingen/shared/World.hpp b/ingen/shared/World.hpp
index 7864c581..9ac0188b 100644
--- a/ingen/shared/World.hpp
+++ b/ingen/shared/World.hpp
@@ -61,6 +61,8 @@ class URIs;
  * The world is used in any process which uses the Ingen as a library, both
  * client and server (e.g. the world may not actually contain an Engine, since
  * it maybe running in another process or even on a different machine).
+ *
+ * @ingroup IngenShared
  */
 class World : public Raul::Noncopyable {
 public:
@@ -100,7 +102,8 @@ public:
 	virtual void add_interface_factory(const std::string& scheme,
 	                                   InterfaceFactory   factory);
 
-	/** Return a new Interface to control the server at @p engine_url.
+	/** Return a new Interface to control a server.
+	 * @param engine_url The URL of the possibly remote server to control.
 	 * @param respondee The Interface that will receive responses to commands
 	 *                  and broadcasts, if applicable.
 	 */