From 3e581ae682dc6050b8b8c41c917ae62a040719d8 Mon Sep 17 00:00:00 2001
From: Mike Buland <eichlan@xagasoft.com>
Date: Wed, 23 Jan 2008 23:34:37 +0000
Subject: Minor changes to documentation, mainly.

---
 src/bzip2.h          | 1 +
 src/doxy/groups.dox  | 5 +++++
 src/file.h           | 4 ++++
 src/filter.h         | 1 +
 src/membuf.h         | 1 +
 src/protocolhttp.h   | 1 +
 src/protocoltelnet.h | 1 +
 src/socket.h         | 3 ++-
 src/stdstream.h      | 3 +++
 src/stream.h         | 1 +
 10 files changed, 20 insertions(+), 1 deletion(-)

(limited to 'src')

diff --git a/src/bzip2.h b/src/bzip2.h
index 0b6946c..f17ce21 100644
--- a/src/bzip2.h
+++ b/src/bzip2.h
@@ -17,6 +17,7 @@ namespace Bu
 {
 	/**
 	 *
+	 *@ingroup Streams
 	 */
 	class BZip2 : public Bu::Filter
 	{
diff --git a/src/doxy/groups.dox b/src/doxy/groups.dox
index 4f2b620..69bb189 100644
--- a/src/doxy/groups.dox
+++ b/src/doxy/groups.dox
@@ -24,3 +24,8 @@
  *@defgroup Taf
  * Taf is the best!
  */
+
+/**
+ *@defgroup Streams
+ * Streams are for data.
+ */
diff --git a/src/file.h b/src/file.h
index b676c2d..ab3e529 100644
--- a/src/file.h
+++ b/src/file.h
@@ -15,6 +15,10 @@
 
 namespace Bu
 {
+	/**
+	 * A file stream.
+	 *@ingroup Streams
+	 */
 	class File : public Bu::Stream
 	{
 	public:
diff --git a/src/filter.h b/src/filter.h
index 57664f6..f86d6c3 100644
--- a/src/filter.h
+++ b/src/filter.h
@@ -32,6 +32,7 @@ namespace Bu
 	 * many filters such as compression filters will buffer data until they have
 	 * enough to create a compression block, in these cases the leftover data
 	 * will be returned by close.
+	 *@ingroup Streams
 	 */
 	class Filter : public Bu::Stream
 	{
diff --git a/src/membuf.h b/src/membuf.h
index a8caa16..993030c 100644
--- a/src/membuf.h
+++ b/src/membuf.h
@@ -17,6 +17,7 @@ namespace Bu
 {
 	/**
 	 * A memory buffer stream.
+	 *@ingroup Streams
 	 */
 	class MemBuf : public Stream
 	{
diff --git a/src/protocolhttp.h b/src/protocolhttp.h
index bcc417f..6a854ea 100644
--- a/src/protocolhttp.h
+++ b/src/protocolhttp.h
@@ -26,6 +26,7 @@ namespace Bu
 	 * the onRequest function in a subclass with the method and URI that were
 	 * requested.  The sub-class can then do whatever it needs to to send back
 	 * a response.
+	 *@ingroup Serving
 	 */
 	class ProtocolHttp : public Protocol
 	{
diff --git a/src/protocoltelnet.h b/src/protocoltelnet.h
index b7a612e..c8bd1b8 100644
--- a/src/protocoltelnet.h
+++ b/src/protocoltelnet.h
@@ -58,6 +58,7 @@ namespace Bu
 	}
 	 @endcode
 	 *
+	 *@ingroup Serving
 	 */
 	class ProtocolTelnet : public Protocol
 	{
diff --git a/src/socket.h b/src/socket.h
index b09f911..eee0be3 100644
--- a/src/socket.h
+++ b/src/socket.h
@@ -17,7 +17,8 @@ namespace Bu
 {
 	/**
 	 *@author Mike Buland
-	 *@ingroup Serving Streams
+	 *@ingroup Serving
+	 *@ingroup Streams
 	 */
 	class Socket : public Stream
 	{
diff --git a/src/stdstream.h b/src/stdstream.h
index 15ac875..3660548 100644
--- a/src/stdstream.h
+++ b/src/stdstream.h
@@ -14,6 +14,9 @@
 
 namespace Bu
 {
+	/**
+	 *@ingroup Streams
+	 */
 	class StdStream : public Stream
 	{
 	public:
diff --git a/src/stream.h b/src/stream.h
index f3cd882..94d10a4 100644
--- a/src/stream.h
+++ b/src/stream.h
@@ -24,6 +24,7 @@ namespace Bu
 	 * The constructor of a child class should pretty much universally be used
 	 * to open the stream.  I can't think of anything that should require an
 	 * exception.
+	 *@ingroup Streams
 	 */
 	class Stream
 	{
-- 
cgit v1.2.3