diff options
author | Mike Buland <eichlan@xagasoft.com> | 2011-10-24 16:42:22 +0000 |
---|---|---|
committer | Mike Buland <eichlan@xagasoft.com> | 2011-10-24 16:42:22 +0000 |
commit | 2f163b90c745491a995dfdbe78464c64a536ec54 (patch) | |
tree | cd2ec92d1f96b0b2edbb979d45fa7beea7127192 | |
parent | 9cb2695ad318dcda83a353b03c21b4fd71d0f9d6 (diff) | |
download | libbu++-2f163b90c745491a995dfdbe78464c64a536ec54.tar.gz libbu++-2f163b90c745491a995dfdbe78464c64a536ec54.tar.bz2 libbu++-2f163b90c745491a995dfdbe78464c64a536ec54.tar.xz libbu++-2f163b90c745491a995dfdbe78464c64a536ec54.zip |
Added some more docs.
Diffstat (limited to '')
-rw-r--r-- | src/bzip2.h | 2 | ||||
-rw-r--r-- | src/deflate.h | 4 | ||||
-rw-r--r-- | src/doxy/groups.dox | 5 | ||||
-rw-r--r-- | src/lzma.h | 3 |
4 files changed, 14 insertions, 0 deletions
diff --git a/src/bzip2.h b/src/bzip2.h index 0b5140d..9a8d172 100644 --- a/src/bzip2.h +++ b/src/bzip2.h | |||
@@ -15,8 +15,10 @@ | |||
15 | namespace Bu | 15 | namespace Bu |
16 | { | 16 | { |
17 | /** | 17 | /** |
18 | * Provides BZip2 type compression and decompression. | ||
18 | * | 19 | * |
19 | *@ingroup Streams | 20 | *@ingroup Streams |
21 | *@ingroup Compression | ||
20 | */ | 22 | */ |
21 | class BZip2 : public Bu::Filter | 23 | class BZip2 : public Bu::Filter |
22 | { | 24 | { |
diff --git a/src/deflate.h b/src/deflate.h index 20d609a..34e8657 100644 --- a/src/deflate.h +++ b/src/deflate.h | |||
@@ -15,8 +15,12 @@ | |||
15 | namespace Bu | 15 | namespace Bu |
16 | { | 16 | { |
17 | /** | 17 | /** |
18 | * Provides Deflate (LZ77) support via zlib. This provides zlib, raw, and | ||
19 | * gzip stream types. By default it will autodetect the input type and | ||
20 | * encode into a raw deflate stream. | ||
18 | * | 21 | * |
19 | *@ingroup Streams | 22 | *@ingroup Streams |
23 | *@ingroup Compression | ||
20 | */ | 24 | */ |
21 | class Deflate : public Bu::Filter | 25 | class Deflate : public Bu::Filter |
22 | { | 26 | { |
diff --git a/src/doxy/groups.dox b/src/doxy/groups.dox index 479186a..6b7cd57 100644 --- a/src/doxy/groups.dox +++ b/src/doxy/groups.dox | |||
@@ -29,3 +29,8 @@ | |||
29 | *@defgroup Streams Streams | 29 | *@defgroup Streams Streams |
30 | * Streams are for data. | 30 | * Streams are for data. |
31 | */ | 31 | */ |
32 | |||
33 | /** | ||
34 | *@defgroup Compression Compression | ||
35 | * Filters that give access to common compression libraries. | ||
36 | */ | ||
@@ -15,8 +15,11 @@ | |||
15 | namespace Bu | 15 | namespace Bu |
16 | { | 16 | { |
17 | /** | 17 | /** |
18 | * Provides XZ compression and decompression, both LZMA1 (LzmaAlone) as | ||
19 | * well as the newer LZMA2 (xz) format. This uses .xz by default. | ||
18 | * | 20 | * |
19 | *@ingroup Streams | 21 | *@ingroup Streams |
22 | *@ingroup Compression | ||
20 | */ | 23 | */ |
21 | class Lzma : public Bu::Filter | 24 | class Lzma : public Bu::Filter |
22 | { | 25 | { |