Touch up documentation (add everything to raul group).

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

19 files changed, 30 insertions, 4 deletions

diff --git a/doc/mainpage.dox b/doc/mainpage.dox
index 24c3f94..b8ad610 100644
--- a/doc/mainpage.dox
+++ b/doc/mainpage.dox
@@ -8,3 +8,5 @@ programming, biased towards audio applications.
 See the class heirarchy for an index of the available functionality.
 
 */
+
+/** @defgroup raul Realtime Audio Utility Library */
diff --git a/raul/Array.hpp b/raul/Array.hpp
index 0075c34..fbc4a23 100644
--- a/raul/Array.hpp
+++ b/raul/Array.hpp
@@ -31,6 +31,7 @@ namespace Raul {
  * Has a stack-like push_back(), but is NOT a resizeable array (the size given
  * to the constructor or alloc method is the maximum number of elements which
  * can be pushed).
+ * \ingroup raul
  */
 template <class T>
 class Array : public Deletable
diff --git a/raul/ArrayStack.hpp b/raul/ArrayStack.hpp
index 6d34426..c00ec22 100644
--- a/raul/ArrayStack.hpp
+++ b/raul/ArrayStack.hpp
@@ -29,6 +29,7 @@ namespace Raul {
 
 
 /** An array that can also be used as a stack (with a fixed maximum size).
+ * \ingroup raul
  */
 template <class T>
 class ArrayStack : public Array<T>
diff --git a/raul/AtomicInt.hpp b/raul/AtomicInt.hpp
index 1f5a45e..ea98791 100644
--- a/raul/AtomicInt.hpp
+++ b/raul/AtomicInt.hpp
@@ -23,6 +23,9 @@
 namespace Raul {
 
 
+/** Atomic integer.
+ * \ingroup raul
+ */
 class AtomicInt {
 public:
 	inline AtomicInt(int val)
diff --git a/raul/AtomicPtr.hpp b/raul/AtomicPtr.hpp
index 834228c..7a1cba7 100644
--- a/raul/AtomicPtr.hpp
+++ b/raul/AtomicPtr.hpp
@@ -23,6 +23,9 @@
 namespace Raul {
 
 
+/** Atomic pointer.
+ * \ingroup raul
+ */
 template<typename T>
 class AtomicPtr {
 public:
diff --git a/raul/DoubleBuffer.hpp b/raul/DoubleBuffer.hpp
index 1e91f37..321f6ba 100644
--- a/raul/DoubleBuffer.hpp
+++ b/raul/DoubleBuffer.hpp
@@ -31,6 +31,7 @@ namespace Raul {
  * Read/Write realtime safe, many writers safe - but set calls may fail.
  *
  * Space:  2*sizeof(T) + sizeof(int) + sizeof(void*)
+ * \ingroup raul
  */
 template<typename T>
 class DoubleBuffer {
diff --git a/raul/EventRingBuffer.hpp b/raul/EventRingBuffer.hpp
index 54e34f7..b7cd4e4 100644
--- a/raul/EventRingBuffer.hpp
+++ b/raul/EventRingBuffer.hpp
@@ -30,6 +30,7 @@ namespace Raul {
  *
  * This packs a timestamp, size, and size bytes of data flat into the buffer.
  * Useful for MIDI events, OSC messages, etc.
+ * \ingroup raul
  */
 class EventRingBuffer : private Raul::RingBuffer {
 public:
diff --git a/raul/List.hpp b/raul/List.hpp
index aa4ddb3..64422a0 100644
--- a/raul/List.hpp
+++ b/raul/List.hpp
@@ -35,6 +35,7 @@ namespace Raul {
  * Elements can be added safely while another thread is reading the list.
  * Like a typical ringbuffer, this is single-reader single-writer threadsafe
  * only.  See documentation for specific functions for specifics.
+ * \ingroup raul 
  */
 template <typename T>
 class List : public Raul::Deletable, public boost::noncopyable
diff --git a/raul/MIDISink.hpp b/raul/MIDISink.hpp
index 6d39823..a1f6ab2 100644
--- a/raul/MIDISink.hpp
+++ b/raul/MIDISink.hpp
@@ -26,6 +26,7 @@ namespace Raul {
 
 
 /** Pure virtual base for anything you can write MIDI to.
+ * \ingroup raul 
  */
 class MIDISink : public Deletable {
 public:
diff --git a/raul/PathTable.hpp b/raul/PathTable.hpp
index 0b47a32..65fa681 100644
--- a/raul/PathTable.hpp
+++ b/raul/PathTable.hpp
@@ -23,6 +23,9 @@
 
 namespace Raul {
 
+/** Table of Paths.
+ * \ingroup raul 
+ */
 template <typename T>
 class PathTable : public Table<Path, T> {
 public:
diff --git a/raul/Quantizer.hpp b/raul/Quantizer.hpp
index 1e15114..4637bb4 100644
--- a/raul/Quantizer.hpp
+++ b/raul/Quantizer.hpp
@@ -23,7 +23,9 @@
 
 namespace Raul {
 
-
+/** Quantizer.
+ * \ingroup raul 
+ */
 class Quantizer {
 public:
 	inline static TimeStamp quantize(TimeStamp q, TimeStamp t) {
diff --git a/raul/RingBuffer.hpp b/raul/RingBuffer.hpp
index e2647fc..f1b8081 100644
--- a/raul/RingBuffer.hpp
+++ b/raul/RingBuffer.hpp
@@ -35,6 +35,7 @@ namespace Raul {
 /** A lock-free RingBuffer.
  * Read/Write realtime safe.
  * Single-reader Single-writer thread safe.
+ * \ingroup raul 
  */
 class RingBuffer {
 public:
diff --git a/raul/SMFReader.hpp b/raul/SMFReader.hpp
index 1e1b5e8..c7bf0ce 100644
--- a/raul/SMFReader.hpp
+++ b/raul/SMFReader.hpp
@@ -29,6 +29,7 @@ namespace Raul {
 /** Standard Midi File (Type 0) Reader
  *
  * Currently this only reads SMF files with tempo-based timing.
+ * \ingroup raul 
  */
 class SMFReader {
 public:
diff --git a/raul/SMFWriter.hpp b/raul/SMFWriter.hpp
index ae62a1d..fe0f9ef 100644
--- a/raul/SMFWriter.hpp
+++ b/raul/SMFWriter.hpp
@@ -28,6 +28,7 @@ namespace Raul {
 
 
 /** Standard Midi File (Type 0) Writer
+ * \ingroup raul 
  */
 class SMFWriter : public Raul::MIDISink {
 public:
diff --git a/raul/Table.hpp b/raul/Table.hpp
index 79817ed..c22c346 100644
--- a/raul/Table.hpp
+++ b/raul/Table.hpp
@@ -36,6 +36,7 @@ namespace Raul {
  * This has the advantage over std::map that iterating over the collection
  * is fast and sorted.  Possibly also faster in some situations due to all
  * data being in a single chunk of memory, cache optimized, etc.
+ * \ingroup raul 
  */
 template <typename K, typename T>
 class Table : public boost::noncopyable {
diff --git a/raul/TimeStamp.hpp b/raul/TimeStamp.hpp
index db17004..16233f4 100644
--- a/raul/TimeStamp.hpp
+++ b/raul/TimeStamp.hpp
@@ -28,6 +28,7 @@ namespace Raul {
 
 
 /** A type of time stamp
+ * \ingroup raul 
  */
 class TimeUnit {
 public:
diff --git a/raul/URI.hpp b/raul/URI.hpp
index 32d3cc5..8f4a8c2 100644
--- a/raul/URI.hpp
+++ b/raul/URI.hpp
@@ -32,6 +32,7 @@ namespace Raul {
  *
  * This "should" be used for proper URIs (RFC3986), but not much support or
  * validation is built-in yet.  The URI string MUST have a scheme though.
+ * \ingroup raul 
  */
 class URI {
 public:
diff --git a/raul/log.hpp b/raul/log.hpp
index 187df64..6e6b81f 100644
--- a/raul/log.hpp
+++ b/raul/log.hpp
@@ -24,6 +24,9 @@
 
 namespace Raul {
 
+/** Buffer for (possibly coloured) log printing.
+ * \ingroup raul 
+ */
 class LogBuffer : public std::streambuf
 {
 public:
diff --git a/raul/midi_names.h b/raul/midi_names.h
index 205a8ec..f1b0662 100644
--- a/raul/midi_names.h
+++ b/raul/midi_names.h
@@ -28,11 +28,9 @@ extern "C" {
 #endif
 
 
-/** \group midi
- */
-
 /** Pass this a symbol defined in midi_events.h (e.g. MIDI_CTL_PAN) to get the
  * short name of a MIDI event/controller according to General MIDI.
+ * \ingroup midi
  */
 inline static const char* midi_name(uint8_t status)
 {