Fix warnings from clang -Wdocumentation.

This commit is contained in:
Lasse Collin 2023-01-12 03:11:40 +02:00
parent a0e7fb1c1e
commit 6c886cc5b3
3 changed files with 4 additions and 8 deletions

View File

@ -108,10 +108,6 @@ extern const uint64_t lzma_crc64_table[4][256];
/// \brief Initialize *check depending on type /// \brief Initialize *check depending on type
///
/// \return LZMA_OK on success. LZMA_UNSUPPORTED_CHECK if the type is not
/// supported by the current version or build of liblzma.
/// LZMA_PROG_ERROR if type > LZMA_CHECK_ID_MAX.
extern void lzma_check_init(lzma_check_state *check, lzma_check type); extern void lzma_check_init(lzma_check_state *check, lzma_check type);
/// Update the check state /// Update the check state

View File

@ -242,8 +242,8 @@ do { \
/// \param cur_match Start position of the current match candidate /// \param cur_match Start position of the current match candidate
/// \param depth Maximum length of the hash chain /// \param depth Maximum length of the hash chain
/// \param son lzma_mf.son (contains the hash chain) /// \param son lzma_mf.son (contains the hash chain)
/// \param cyclic_pos /// \param cyclic_pos lzma_mf.cyclic_pos
/// \param cyclic_size /// \param cyclic_size lzma_mf_cyclic_size
/// \param matches Array to hold the matches. /// \param matches Array to hold the matches.
/// \param len_best The length of the longest match found so far. /// \param len_best The length of the longest match found so far.
static lzma_match * static lzma_match *

View File

@ -49,13 +49,13 @@ typedef struct {
/// is called, which should update the given value to filter-specific /// is called, which should update the given value to filter-specific
/// options structure. /// options structure.
/// ///
/// This returns only if no errors occur.
///
/// \param str String containing the options from the command line /// \param str String containing the options from the command line
/// \param opts Filter-specific option map /// \param opts Filter-specific option map
/// \param set Filter-specific function to update filter_options /// \param set Filter-specific function to update filter_options
/// \param filter_options Pointer to filter-specific options structure /// \param filter_options Pointer to filter-specific options structure
/// ///
/// \return Returns only if no errors occur.
///
static void static void
parse_options(const char *str, const option_map *opts, parse_options(const char *str, const option_map *opts,
void (*set)(void *filter_options, void (*set)(void *filter_options,