From 65c9e9f0230d2da3cc9b68e96daf80f5aeb8c40c Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Tue, 25 Mar 2025 01:15:34 +0100 Subject: [PATCH] Doxify version functions. The two auto-generated public functions come undoxified, so document their declarations in string.h. Fixes: 69bace22205b4bb01673f7c9873f57a43bd6a0f7 --- string.h | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/string.h b/string.h index 99fa8324..361535e6 100644 --- a/string.h +++ b/string.h @@ -98,8 +98,29 @@ int skip_cells(const char *s, size_t cells_to_skip, size_t *result); __must_check int strwidth(const char *s, size_t *result); __must_check int sanitize_str(const char *src, size_t max_width, char **result, size_t *width); +/** + * Return the single line git version string. + * + * This is what the version subcommands of para_server and para_audiod output. + * The function is defined in an auto-generated .c file which gets updated by + * the build system when the git version changes. + * + * \return A pointer to a constant string. Don't free! + */ const char *paraslash_version(void); + +/** + * Return multi-line version information (license, links, etc.). + * + * All paraslash executables output this when run with -V. Also the version + * subcommands of para_server and para_audiod send this string to the client if + * the verbose flag was given. The function is defined in the same + * auto-generated file as \ref paraslash_version(). + * + * \return A pointer to a constant string. Don't free! + */ const char *paraslash_info(void); + const char *version_single_line(const char *pfx); const char *version_text(const char *pfx); void version_handle_flag(const char *pfx, bool flag); -- 2.39.5