From 7d943a9c214189797604f7042e65ed4f79ea0e5c Mon Sep 17 00:00:00 2001 From: akallabeth Date: Sun, 25 Jan 2026 09:38:33 +0100 Subject: [PATCH] [documentation] fix a few doxygen warnings --- include/freerdp/client/rdpdr.h | 6 ++++-- include/freerdp/settings.h | 9 ++++++--- include/freerdp/utils/aad.h | 3 ++- winpr/include/winpr/collections.h | 17 +++++++---------- winpr/include/winpr/json.h | 5 +++-- 5 files changed, 22 insertions(+), 18 deletions(-) diff --git a/include/freerdp/client/rdpdr.h b/include/freerdp/client/rdpdr.h index c2262f731..391c351f1 100644 --- a/include/freerdp/client/rdpdr.h +++ b/include/freerdp/client/rdpdr.h @@ -28,7 +28,8 @@ extern "C" { #endif - /** @enum Hotplug event types. + /** @enum RdpdrHotplugEventType + * @brief Hotplug event types. * * @since version 3.16.0 */ @@ -75,7 +76,8 @@ extern "C" */ typedef UINT (*pcRdpdrHotplugDevice)(RdpdrClientContext* context, RdpdrHotplugEventType type); - /** @struct rdpdr channel client context + /** @struct s_rdpdr_client_context + * @brief rdpdr channel client context * * @since version 3.16.0 */ diff --git a/include/freerdp/settings.h b/include/freerdp/settings.h index ed694e300..2c0ce8c7a 100644 --- a/include/freerdp/settings.h +++ b/include/freerdp/settings.h @@ -738,9 +738,12 @@ extern "C" FREERDP_API const char* freerdp_encryption_methods_string(UINT32 EncryptionLevel, char* buffer, size_t size); - /** \brief returns a string representation of \b RNS_UD_XXBPP_SUPPORT values + /** @brief returns a string representation of \b RNS_UD_XXBPP_SUPPORT values + * @param mask A bitmask of supported color dephts \b RNS_UD_* + * @param buffer A pointer to a buffer of \b size bytes + * @param size The size of the buffer in bytes * - * return A string reprenentation of the bitmask. + * @return A string reprenentation of the bitmask. */ FREERDP_API const char* freerdp_supported_color_depths_string(UINT16 mask, char* buffer, size_t size); @@ -748,7 +751,7 @@ extern "C" /** \brief return the configuration directory for the library * @return The current configuration path or \b NULL * @since version 3.6.0 - * @note Since 3.17.1 this is a wrapper for \ref freerdp_GetConfigFilePath(FALSE, "") + * @note Since 3.17.1 this is a wrapper for \b freerdp_GetConfigFilePath(FALSE, "") */ WINPR_ATTR_MALLOC(free, 1) FREERDP_API char* freerdp_settings_get_config_path(void); diff --git a/include/freerdp/utils/aad.h b/include/freerdp/utils/aad.h index a1a6978a8..c6d53e600 100644 --- a/include/freerdp/utils/aad.h +++ b/include/freerdp/utils/aad.h @@ -36,7 +36,8 @@ extern "C" { #endif - /** @enum Expected wellknown fields to be supported + /** @enum AAD_WELLKNOWN_VALUES + * @brief Expected wellknown fields to be supported * @since version 3.10.0 */ typedef enum diff --git a/winpr/include/winpr/collections.h b/winpr/include/winpr/collections.h index 19b73884e..23f932287 100644 --- a/winpr/include/winpr/collections.h +++ b/winpr/include/winpr/collections.h @@ -47,19 +47,16 @@ extern "C" /** @struct wObject * @brief This struct contains function pointer to initialize/free objects * - * @var fnObjectNew A new function that creates a clone of the input - * @var fnObjectInit A function initializing an object, but not allocating it - * @var fnObjectUninit A function to deinitialize an object, but not free it - * @var fnObjectFree A function freeing an object - * @var fnObjectEquals A function to compare two objects */ typedef struct { - OBJECT_NEW_FN fnObjectNew; - OBJECT_INIT_FN fnObjectInit; - OBJECT_UNINIT_FN fnObjectUninit; - OBJECT_FREE_FN fnObjectFree; - OBJECT_EQUALS_FN fnObjectEquals; + OBJECT_NEW_FN fnObjectNew; /**< A new function that creates a clone of the input */ + OBJECT_INIT_FN + fnObjectInit; /**< A function initializing an object, but not allocating it */ + OBJECT_UNINIT_FN + fnObjectUninit; /**< A function to deinitialize an object, but not free it */ + OBJECT_FREE_FN fnObjectFree; /**< A function freeing an object */ + OBJECT_EQUALS_FN fnObjectEquals; /**< A function to compare two objects */ } wObject; /* utility function with compatible arguments for string data */ diff --git a/winpr/include/winpr/json.h b/winpr/include/winpr/json.h index de48124fc..eef4c7a66 100644 --- a/winpr/include/winpr/json.h +++ b/winpr/include/winpr/json.h @@ -120,7 +120,8 @@ extern "C" * @brief Return a pointer to an JSON object item * @param object the JSON object * @param string the name of the object (case is ignored) - * @return A pointer to the object identified by @ref string or \b NULL + * + * @return A pointer to the object identified by \b string or \b NULL * @since version 3.6.0 */ WINPR_API WINPR_JSON* WINPR_JSON_GetObjectItem(const WINPR_JSON* object, const char* string); @@ -130,7 +131,7 @@ extern "C" * * @param object the JSON instance to query * @param string the name of the object - * @return A pointer to the object identified by @ref string or \b NULL + * @return A pointer to the object identified by \b string or \b NULL * @since version 3.6.0 */ WINPR_API WINPR_JSON* WINPR_JSON_GetObjectItemCaseSensitive(const WINPR_JSON* object,