From 9cb4414e3bb977443bcf5303f77c99b31af09e86 Mon Sep 17 00:00:00 2001 From: borine <32966433+borine@users.noreply.github.com> Date: Sun, 30 Jul 2023 09:48:53 +0100 Subject: [PATCH] doxygen: conf: silence 'not documented' warnings From: borine@github Link: https://github.com/alsa-project/alsa-lib/pull/340 Signed-off-by: Jaroslav Kysela --- doc/doxygen.cfg.in | 1 + include/conf.h | 12 +++++++++++- src/conf.c | 33 +++++++++++++++++++++++++++++---- src/confeval.c | 6 +++++- src/confmisc.c | 2 +- 5 files changed, 47 insertions(+), 7 deletions(-) diff --git a/doc/doxygen.cfg.in b/doc/doxygen.cfg.in index 1a5dbf56..5333f6da 100644 --- a/doc/doxygen.cfg.in +++ b/doc/doxygen.cfg.in @@ -36,6 +36,7 @@ INPUT = @top_srcdir@/doc/index.doxygen \ @top_srcdir@/src/input.c \ @top_srcdir@/src/output.c \ @top_srcdir@/src/conf.c \ + @top_srcdir@/src/confeval.c \ @top_srcdir@/src/confmisc.c \ @top_srcdir@/src/names.c \ @top_srcdir@/src/shmarea.c \ diff --git a/include/conf.h b/include/conf.h index 800707d9..09da0e9a 100644 --- a/include/conf.h +++ b/include/conf.h @@ -33,7 +33,7 @@ extern "C" { #endif /** - * \defgroup Config Configuration Interface + * \defgroup Configuration Configuration Interface * The configuration functions and types allow you to read, enumerate, * modify and write the contents of ALSA configuration files. * \{ @@ -109,6 +109,16 @@ int snd_config_search_definition(snd_config_t *config, const char *base, const char *key, snd_config_t **result); +/** + * \brief custom expansion callback + * \param[out] dst The function puts the handle to the new configuration + * node at the address specified by \a dst. + * \param[in] s string the string to be expanded + * \param[in] private_data Handle to the \c private_data node. + * \return A non-negative value if successful, otherwise a negative error code. + * + * Use a function of this type to define a custom expansion + */ typedef int (*snd_config_expand_fcn_t)(snd_config_t **dst, const char *s, void *private_data); int snd_config_expand_custom(snd_config_t *config, snd_config_t *root, diff --git a/src/conf.c b/src/conf.c index 9887d0e9..eca44c03 100644 --- a/src/conf.c +++ b/src/conf.c @@ -527,7 +527,7 @@ static inline void snd_config_unlock(void) { } #endif /* - * Add a diretory to the paths to search included files. + * Add a directory to the paths to search included files. * param fd - File object that owns these paths to search files included by it. * param dir - Path of the directory to add. Allocated externally and need to * be freed manually later. @@ -584,6 +584,8 @@ static void free_include_paths(struct filedesc *fd) } } +#endif /* DOC_HIDDEN */ + /** * \brief Returns the default top-level config directory * \return The top-level config directory path string @@ -605,6 +607,8 @@ const char *snd_config_topdir(void) return topdir; } +#ifndef DOC_HIDDEN + static char *_snd_config_path(const char *name) { const char *root = snd_config_topdir(); @@ -1700,7 +1704,7 @@ static int _snd_config_save_children(snd_config_t *config, snd_output_t *out, } return 0; } -#endif +#endif /* DOC_HIDDEN */ /** @@ -2873,6 +2877,26 @@ int snd_config_imake_string(snd_config_t **config, const char *id, const char *v return 0; } +/** + * \brief Creates a string configuration node with the given initial value. + * \param[out] config The function puts the handle to the new node at + * the address specified by \a config. + * \param[in] id The id of the new node. + * \param[in] value The initial value of the new node. May be \c NULL. + * \return Zero if successful, otherwise a negative error code. + * + * This function creates a new node of type #SND_CONFIG_TYPE_STRING. The node + * contains with a copy of the string \c value, replacing any character other + * than alphanumeric, space, or '-' with the character '_'. + * + * \par Errors: + *
+ *
-ENOMEM
Out of memory. + *
+ * + * \par Conforming to: + * LSB 3.2 + */ int snd_config_imake_safe_string(snd_config_t **config, const char *id, const char *value) { int err; @@ -3894,7 +3918,6 @@ int snd_config_search_alias_hooks(snd_config_t *config, #define ALSA_CONFIG_PATH_VAR "ALSA_CONFIG_PATH" /** - * \ingroup Config * \brief Configuration top-level node (the global configuration). * * This variable contains a handle to the top-level configuration node, @@ -4295,7 +4318,7 @@ SND_DLSYM_BUILD_VERSION(snd_config_hook_load, SND_CONFIG_DLSYM_VERSION_HOOK); int snd_determine_driver(int card, char **driver); #endif -snd_config_t *_snd_config_hook_private_data(int card, const char *driver) +static snd_config_t *_snd_config_hook_private_data(int card, const char *driver) { snd_config_t *private_data, *v; int err; @@ -5810,6 +5833,7 @@ static void _snd_config_end(void) } #endif +#ifndef DOC_HIDDEN size_t page_size(void) { long s = sysconf(_SC_PAGE_SIZE); @@ -5845,3 +5869,4 @@ size_t page_ptr(size_t object_offset, size_t object_size, size_t *offset, size_t *offset = object_offset; return r; } +#endif /* DOC_HIDDEN */ diff --git a/src/confeval.c b/src/confeval.c index a27ee1d1..56b6ebec 100644 --- a/src/confeval.c +++ b/src/confeval.c @@ -38,7 +38,9 @@ #include #include +#ifndef DOC_HIDDEN typedef long long value_type_t; +#endif /* DOC_HIDDEN */ static const char *_find_end_of_expression(const char *s, char begin, char end) { @@ -119,6 +121,7 @@ static int _to_integer(value_type_t *val, snd_config_t *c) return err; } +#ifndef DOC_HIDDEN int _snd_eval_string(snd_config_t **dst, const char *s, snd_config_expand_fcn_t fcn, void *private_data) { @@ -244,6 +247,7 @@ int _snd_eval_string(snd_config_t **dst, const char *s, else return snd_config_imake_integer(dst, NULL, left); } +#endif /* DOC_HIDDEN */ /** * \brief Evaluate an math expression in the string @@ -251,7 +255,7 @@ int _snd_eval_string(snd_config_t **dst, const char *s, * node at the address specified by \a dst. * \param[in] s A string to evaluate * \param[in] fcn A function to get the variable contents - * \param[in] private_value A private value for the variable contents function + * \param[in] private_data A private value for the variable contents function * \return 0 if successful, otherwise a negative error code. */ int snd_config_evaluate_string(snd_config_t **dst, const char *s, diff --git a/src/confmisc.c b/src/confmisc.c index b55d86f7..0559fb66 100644 --- a/src/confmisc.c +++ b/src/confmisc.c @@ -645,7 +645,7 @@ static int string_from_integer(char **dst, long v) } #endif -int _snd_func_private_data(snd_config_t **dst, snd_config_t *src, +static int _snd_func_private_data(snd_config_t **dst, snd_config_t *src, snd_config_t **private_data, const char *id) { int err; -- 2.47.1