diff options
author | Marcus Brinkmann <[email protected]> | 2017-11-26 03:04:55 +0100 |
---|---|---|
committer | Marcus Brinkmann <[email protected]> | 2017-11-26 03:04:55 +0100 |
commit | c6411a8e484a5180a81cbc091498c0c395758cac (patch) | |
tree | 573ecd96d966cbbb1370b157cc31047a28dec68d /src/lib/compression | |
parent | 34aa73d0f9c3bf817a0a46889206003f0becd3f1 (diff) |
Documentation fix in compression create/create_or_throw functions.
Diffstat (limited to 'src/lib/compression')
-rw-r--r-- | src/lib/compression/compression.h | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/src/lib/compression/compression.h b/src/lib/compression/compression.h index 403b335e1..c207b8bdb 100644 --- a/src/lib/compression/compression.h +++ b/src/lib/compression/compression.h @@ -21,8 +21,7 @@ class BOTAN_PUBLIC_API(2,0) Compression_Algorithm public: /** * Create an instance based on a name, or return null if the - * algo/provider combination cannot be found. If provider is - * empty then best available is chosen. + * algo combination cannot be found. */ static std::unique_ptr<Compression_Algorithm> create(const std::string& algo_spec); @@ -30,7 +29,7 @@ class BOTAN_PUBLIC_API(2,0) Compression_Algorithm /** * Create an instance based on a name * @param algo_spec algorithm name - * Throws Lookup_Error if not not found. + * Throws Lookup_Error if not found. */ static std::unique_ptr<Compression_Algorithm> create_or_throw(const std::string& algo_spec); @@ -83,8 +82,7 @@ class BOTAN_PUBLIC_API(2,0) Decompression_Algorithm public: /** * Create an instance based on a name, or return null if the - * algo/provider combination cannot be found. If provider is - * empty then best available is chosen. + * algo combination cannot be found. */ static std::unique_ptr<Decompression_Algorithm> create(const std::string& algo_spec); @@ -92,7 +90,7 @@ class BOTAN_PUBLIC_API(2,0) Decompression_Algorithm /** * Create an instance based on a name * @param algo_spec algorithm name - * Throws Lookup_Error if not not found. + * Throws Lookup_Error if not found. */ static std::unique_ptr<Decompression_Algorithm> create_or_throw(const std::string& algo_spec); |