aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorJia Tan <jiat0218@gmail.com>2023-02-14 21:50:16 +0800
committerJia Tan <jiat0218@gmail.com>2023-02-15 22:21:44 +0800
commit13d99e75a543e9e5f8633cc241eae55b91a3b242 (patch)
treecff9afcbae26031b986c6f68f572a517523dc6fb /src
parentliblzma: Improve documentation in check.h. (diff)
downloadxz-13d99e75a543e9e5f8633cc241eae55b91a3b242.tar.xz
liblzma: Improve documentation in lzma12.h.
All functions now explicitly specify parameter and return values.
Diffstat (limited to 'src')
-rw-r--r--src/liblzma/api/lzma/lzma12.h32
1 files changed, 23 insertions, 9 deletions
diff --git a/src/liblzma/api/lzma/lzma12.h b/src/liblzma/api/lzma/lzma12.h
index cd520520..dcc762df 100644
--- a/src/liblzma/api/lzma/lzma12.h
+++ b/src/liblzma/api/lzma/lzma12.h
@@ -138,16 +138,20 @@ typedef enum {
/**
* \brief Test if given match finder is supported
*
- * Return true if the given match finder is supported by this liblzma build.
- * Otherwise false is returned. It is safe to call this with a value that
- * isn't listed in lzma_match_finder enumeration; the return value will be
- * false.
+ * It is safe to call this with a value that isn't listed in
+ * lzma_match_finder enumeration; the return value will be false.
*
* There is no way to list which match finders are available in this
* particular liblzma version and build. It would be useless, because
* a new match finder, which the application developer wasn't aware,
* could require giving additional options to the encoder that the older
* match finders don't need.
+ *
+ * \param match_finder Match finder ID
+ *
+ * \return lzma_bool:
+ * - true if the match finder is supported by this liblzma build.
+ * - false otherwise.
*/
extern LZMA_API(lzma_bool) lzma_mf_is_supported(lzma_match_finder match_finder)
lzma_nothrow lzma_attr_const;
@@ -182,14 +186,20 @@ typedef enum {
/**
* \brief Test if given compression mode is supported
*
- * Return true if the given compression mode is supported by this liblzma
- * build. Otherwise false is returned. It is safe to call this with a value
- * that isn't listed in lzma_mode enumeration; the return value will be false.
+ * It is safe to call this with a value that isn't listed in lzma_mode
+ * enumeration; the return value will be false.
*
* There is no way to list which modes are available in this particular
* liblzma version and build. It would be useless, because a new compression
* mode, which the application developer wasn't aware, could require giving
* additional options to the encoder that the older modes don't need.
+ *
+ * \param mode Mode ID.
+ *
+ * \return lzma_bool:
+ * - true if the compression mode is supported by this liblzma
+ * build.
+ * - false otherwise.
*/
extern LZMA_API(lzma_bool) lzma_mode_is_supported(lzma_mode mode)
lzma_nothrow lzma_attr_const;
@@ -545,8 +555,12 @@ do { \
* This function is available only if LZMA1 or LZMA2 encoder has been enabled
* when building liblzma.
*
- * \return On success, false is returned. If the preset is not
- * supported, true is returned.
+ * \param[out] options Pointer to LZMA12 options to be filled
+ * \param preset Preset value between 0-9 ORed with preset flags
+ *
+ * \return lzma_bool:
+ * - true if the preset is not supported (failure).
+ * - false otherwise (success).
*/
extern LZMA_API(lzma_bool) lzma_lzma_preset(
lzma_options_lzma *options, uint32_t preset) lzma_nothrow;