diff options
| author | Mike Buland <eichlan@xagasoft.com> | 2008-01-23 23:34:37 +0000 |
|---|---|---|
| committer | Mike Buland <eichlan@xagasoft.com> | 2008-01-23 23:34:37 +0000 |
| commit | 3e581ae682dc6050b8b8c41c917ae62a040719d8 (patch) | |
| tree | a28ca879526d870c49108188e8f88ccd571e9a76 | |
| parent | 51f9aa16cbdd78c0b31483df26d0f7e81376f974 (diff) | |
| download | libbu++-3e581ae682dc6050b8b8c41c917ae62a040719d8.tar.gz libbu++-3e581ae682dc6050b8b8c41c917ae62a040719d8.tar.bz2 libbu++-3e581ae682dc6050b8b8c41c917ae62a040719d8.tar.xz libbu++-3e581ae682dc6050b8b8c41c917ae62a040719d8.zip | |
Minor changes to documentation, mainly.
Diffstat (limited to '')
| -rw-r--r-- | src/bzip2.h | 1 | ||||
| -rw-r--r-- | src/doxy/groups.dox | 5 | ||||
| -rw-r--r-- | src/file.h | 4 | ||||
| -rw-r--r-- | src/filter.h | 1 | ||||
| -rw-r--r-- | src/membuf.h | 1 | ||||
| -rw-r--r-- | src/protocolhttp.h | 1 | ||||
| -rw-r--r-- | src/protocoltelnet.h | 1 | ||||
| -rw-r--r-- | src/socket.h | 3 | ||||
| -rw-r--r-- | src/stdstream.h | 3 | ||||
| -rw-r--r-- | src/stream.h | 1 |
10 files changed, 20 insertions, 1 deletions
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 | |||
| 17 | { | 17 | { |
| 18 | /** | 18 | /** |
| 19 | * | 19 | * |
| 20 | *@ingroup Streams | ||
| 20 | */ | 21 | */ |
| 21 | class BZip2 : public Bu::Filter | 22 | class BZip2 : public Bu::Filter |
| 22 | { | 23 | { |
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 @@ | |||
| 24 | *@defgroup Taf | 24 | *@defgroup Taf |
| 25 | * Taf is the best! | 25 | * Taf is the best! |
| 26 | */ | 26 | */ |
| 27 | |||
| 28 | /** | ||
| 29 | *@defgroup Streams | ||
| 30 | * Streams are for data. | ||
| 31 | */ | ||
| @@ -15,6 +15,10 @@ | |||
| 15 | 15 | ||
| 16 | namespace Bu | 16 | namespace Bu |
| 17 | { | 17 | { |
| 18 | /** | ||
| 19 | * A file stream. | ||
| 20 | *@ingroup Streams | ||
| 21 | */ | ||
| 18 | class File : public Bu::Stream | 22 | class File : public Bu::Stream |
| 19 | { | 23 | { |
| 20 | public: | 24 | 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 | |||
| 32 | * many filters such as compression filters will buffer data until they have | 32 | * many filters such as compression filters will buffer data until they have |
| 33 | * enough to create a compression block, in these cases the leftover data | 33 | * enough to create a compression block, in these cases the leftover data |
| 34 | * will be returned by close. | 34 | * will be returned by close. |
| 35 | *@ingroup Streams | ||
| 35 | */ | 36 | */ |
| 36 | class Filter : public Bu::Stream | 37 | class Filter : public Bu::Stream |
| 37 | { | 38 | { |
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 | |||
| 17 | { | 17 | { |
| 18 | /** | 18 | /** |
| 19 | * A memory buffer stream. | 19 | * A memory buffer stream. |
| 20 | *@ingroup Streams | ||
| 20 | */ | 21 | */ |
| 21 | class MemBuf : public Stream | 22 | class MemBuf : public Stream |
| 22 | { | 23 | { |
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 | |||
| 26 | * the onRequest function in a subclass with the method and URI that were | 26 | * the onRequest function in a subclass with the method and URI that were |
| 27 | * requested. The sub-class can then do whatever it needs to to send back | 27 | * requested. The sub-class can then do whatever it needs to to send back |
| 28 | * a response. | 28 | * a response. |
| 29 | *@ingroup Serving | ||
| 29 | */ | 30 | */ |
| 30 | class ProtocolHttp : public Protocol | 31 | class ProtocolHttp : public Protocol |
| 31 | { | 32 | { |
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 | |||
| 58 | } | 58 | } |
| 59 | @endcode | 59 | @endcode |
| 60 | * | 60 | * |
| 61 | *@ingroup Serving | ||
| 61 | */ | 62 | */ |
| 62 | class ProtocolTelnet : public Protocol | 63 | class ProtocolTelnet : public Protocol |
| 63 | { | 64 | { |
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 | |||
| 17 | { | 17 | { |
| 18 | /** | 18 | /** |
| 19 | *@author Mike Buland | 19 | *@author Mike Buland |
| 20 | *@ingroup Serving Streams | 20 | *@ingroup Serving |
| 21 | *@ingroup Streams | ||
| 21 | */ | 22 | */ |
| 22 | class Socket : public Stream | 23 | class Socket : public Stream |
| 23 | { | 24 | { |
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 @@ | |||
| 14 | 14 | ||
| 15 | namespace Bu | 15 | namespace Bu |
| 16 | { | 16 | { |
| 17 | /** | ||
| 18 | *@ingroup Streams | ||
| 19 | */ | ||
| 17 | class StdStream : public Stream | 20 | class StdStream : public Stream |
| 18 | { | 21 | { |
| 19 | public: | 22 | 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 | |||
| 24 | * The constructor of a child class should pretty much universally be used | 24 | * The constructor of a child class should pretty much universally be used |
| 25 | * to open the stream. I can't think of anything that should require an | 25 | * to open the stream. I can't think of anything that should require an |
| 26 | * exception. | 26 | * exception. |
| 27 | *@ingroup Streams | ||
| 27 | */ | 28 | */ |
| 28 | class Stream | 29 | class Stream |
| 29 | { | 30 | { |
