diff --git a/include/freerdp/channels/location.h b/include/freerdp/channels/location.h index 622bd6b1b..315475937 100644 --- a/include/freerdp/channels/location.h +++ b/include/freerdp/channels/location.h @@ -24,7 +24,9 @@ #include #include -/** @defgroup channel_location +/** @defgroup channel_location Location Channel + * @brief Location channel providing redirection of client side Network/GPS location to the RDP + * server * @{ */ diff --git a/include/freerdp/channels/rdpemsc.h b/include/freerdp/channels/rdpemsc.h index 8acd31f65..e2ebb7995 100644 --- a/include/freerdp/channels/rdpemsc.h +++ b/include/freerdp/channels/rdpemsc.h @@ -20,11 +20,11 @@ #ifndef FREERDP_CHANNEL_RDPEMSC_H #define FREERDP_CHANNEL_RDPEMSC_H -/** @defgroup channel_rdpemsc +/** @defgroup channel_rdpemsc [MS-RDPEMSC] * @{ */ -/** \file [MS-RDPEMSC] Mouse Cursor Virtual Channel Extension +/** \file @code [MS-RDPEMSC] @endcode Mouse Cursor Virtual Channel Extension * \link * https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rdpemsc/2591b507-cd5a-4537-be29-b45540543dc8 * \since version 3.0.0 diff --git a/include/freerdp/codec/color.h b/include/freerdp/codec/color.h index 1612ad4e2..fbd9f8a87 100644 --- a/include/freerdp/codec/color.h +++ b/include/freerdp/codec/color.h @@ -67,7 +67,8 @@ extern "C" * X for alpha channel denotes unused (but existing) alpha channel data. */ -/** @defgroup PIXEL_FORMAT +/** @defgroup PIXEL_FORMAT Pixel formats + * @brief PIXEL color ordering formats known * @{ */ /* 32bpp formats */ @@ -387,7 +388,8 @@ typedef struct gdi_palette gdiPalette; UINT32 nXSrc, UINT32 nYSrc, const gdiPalette* WINPR_RESTRICT palette, UINT32 flags); - /*** Same as @freerdp_image_copy but only for overlapping source and destination + /** + * @brief Same as @ref freerdp_image_copy but only for overlapping source and destination * @since version 3.6.0 */ FREERDP_API BOOL freerdp_image_copy_overlap( @@ -395,7 +397,7 @@ typedef struct gdi_palette gdiPalette; UINT32 nHeight, const BYTE* pSrcData, DWORD SrcFormat, UINT32 nSrcStep, UINT32 nXSrc, UINT32 nYSrc, const gdiPalette* WINPR_RESTRICT palette, UINT32 flags); - /*** Same as @freerdp_image_copy but only for non overlapping source and destination + /*** Same as @ref freerdp_image_copy but only for non overlapping source and destination * @since version 3.6.0 */ FREERDP_API BOOL freerdp_image_copy_no_overlap( diff --git a/include/freerdp/locale/locale.h b/include/freerdp/locale/locale.h index 8b2c2a5e0..43b0b1883 100644 --- a/include/freerdp/locale/locale.h +++ b/include/freerdp/locale/locale.h @@ -30,7 +30,7 @@ #include #include -/** @defgroup keyboard-identifiers +/** @defgroup keyboard-identifiers Keyboard Layout Identifiers * @{ */ #define AFRIKAANS 0x0436 @@ -265,7 +265,7 @@ extern "C" /** * @brief Query the list of supported system locales * @param count A pointer to hold the number of locales found - * @return A pointer to @SYSTEM_LOCALE or \b NULL in case none found + * @return A pointer to @ref SYSTEM_LOCALE or \b NULL in case none found * @since version 3.6.0 */ FREERDP_API const SYSTEM_LOCALE* freerdp_get_system_locale_list(size_t* count); @@ -280,9 +280,9 @@ extern "C" FREERDP_API INT64 freerdp_get_locale_id_from_string(const char* locale); /** - * @brief Return the default @keyboard-identifiers for a provided locale + * @brief Return the default @ref keyboard-identifiers for a provided locale * @param locale The locale to query - * @return The @keyboard-identifiers to use + * @return The @ref keyboard-identifiers to use * @since version 3.6.0 */ FREERDP_API DWORD freerdp_get_keyboard_default_layout_for_locale(DWORD locale); diff --git a/include/freerdp/primitives.h b/include/freerdp/primitives.h index 7823e5863..ed73a702f 100644 --- a/include/freerdp/primitives.h +++ b/include/freerdp/primitives.h @@ -117,19 +117,19 @@ typedef pstatus_t (*__add_16s_inplace_t)(INT16* WINPR_RESTRICT pSrcDst1, * @brief Copy (sub)image data without overlapping * * @param pDstData The destination image buffer - * @param DstFormat The destination image format @PIXEL_FORMAT + * @param DstFormat The destination image format @ref PIXEL_FORMAT * @param nDstStep The destination image line width in bytes (including padding) * @param nXDst The X coordinate to start copying to * @param nYDst The Y coordinate to start copying to * @param nWidth The width in pixels to copy * @param nHeight The height in pixels to copy * @param pSrcData The source image buffer - * @param SrcFormat The source image format @PIXEL_FORMAT + * @param SrcFormat The source image format @ref PIXEL_FORMAT * @param nSrcStep The source image line with in bytes (including padding) * @param nXSrc The X coordinate to start copying from * @param nYSrc The Y coordinate to start copying from * @param palette A color palette for 8 bit colors - * @param flags Copy flags @FREERDP_IMAGE_FLAGS + * @param flags Copy flags @ref FREERDP_IMAGE_FLAGS * @return \b <=0 for failure, success otherwise * @since version 3.6.0 */ diff --git a/include/freerdp/server/proxy/proxy_config.h b/include/freerdp/server/proxy/proxy_config.h index 5441b88f6..73f770706 100644 --- a/include/freerdp/server/proxy/proxy_config.h +++ b/include/freerdp/server/proxy/proxy_config.h @@ -26,7 +26,7 @@ #include #include -/** @defgroup proxy_config +/** @defgroup proxy_config Proxy Configuration * @ingroup proxy * @{ */ diff --git a/include/freerdp/settings.h b/include/freerdp/settings.h index 355069e70..9088135ad 100644 --- a/include/freerdp/settings.h +++ b/include/freerdp/settings.h @@ -47,7 +47,7 @@ extern "C" { #endif - /** \defgroup rdpSettings + /** \defgroup rdpSettings rdpSettings * \brief This is the FreeRDP settings module. * * Settings are used to store configuration data for an RDP connection. @@ -490,7 +490,8 @@ extern "C" const char* param); /** \brief appends a string to a settings value. The \b param is copied. - * If the initial value of the setting was not empty, is created + * If the initial value of the setting was not empty, @code + * @endcode is created * * \param settings A pointer to the settings to query, must not be NULL. * \param id The key to query diff --git a/include/freerdp/transport_io.h b/include/freerdp/transport_io.h index 566ca04bc..1e9de38dc 100644 --- a/include/freerdp/transport_io.h +++ b/include/freerdp/transport_io.h @@ -35,7 +35,7 @@ extern "C" /** * @brief Read data from a transport layer - * @param userContext + * @param userContext user defined context passed by @ref freerdp_set_io_callback_context * @param data a buffer to read to * @param bytes the size of the buffer * @return the number of bytes read or <0 for failures @@ -45,7 +45,7 @@ extern "C" /** * @brief write data to a transport layer - * @param userContext + * @param userContext user defined context passed by @ref freerdp_set_io_callback_context * @param data a buffer to write * @param bytes the size of the buffer * @return the number of bytes written or <0 for failures @@ -78,7 +78,8 @@ extern "C" typedef SSIZE_T (*pTransportRead)(rdpTransport* transport, BYTE* data, size_t bytes); typedef BOOL (*pTransportGetPublicKey)(rdpTransport* transport, const BYTE** data, DWORD* length); - /** @brief + /** + * @brief Mofify transport behaviour between bocking and non blocking operation * * @param transport The transport to manipulate * @param blocking Boolean to set the transport \b TRUE blocking and \b FALSE non-blocking @@ -90,10 +91,11 @@ extern "C" typedef rdpTransportLayer* (*pTransportConnectLayer)(rdpTransport* transport, const char* hostname, int port, DWORD timeout); - /** @brief Return the public key as PEM from transport layer. + + /** + * @brief Return the public key as PEM from transport layer. * @param transport the transport to query - * @param data A pointer to hold the allocated result - * @param length A pointer to hold the length in bytes of the result + * @param layer the transport layer to attach * * @return \b TRUE for success, \b FALSE for failure * @since version 3.2.0 diff --git a/include/freerdp/utils/aad.h b/include/freerdp/utils/aad.h index 4d65a9130..06ae2c16e 100644 --- a/include/freerdp/utils/aad.h +++ b/include/freerdp/utils/aad.h @@ -21,7 +21,7 @@ #ifndef FREERDP_UTILS_AAD_H #define FREERDP_UTILS_AAD_H -/** \file AAD related helper utilities +/** \defgroup AAD AAD related helper utilities * \since version 3.0.0 */ #include diff --git a/libfreerdp/core/gateway/arm.c b/libfreerdp/core/gateway/arm.c index 09bd7e134..7b023d518 100644 --- a/libfreerdp/core/gateway/arm.c +++ b/libfreerdp/core/gateway/arm.c @@ -323,12 +323,14 @@ arm_create_cleanup: } /** - * treats the redirectedAuthBlob + * @brief treats the redirectedAuthBlob * * sample pbInput: + * @code * 41004500530000004b44424d01000000200000006ee71b295810b3fd13799da3825d0efa3a628e8f4a6eda609ffa975408556546 * 'A\x00E\x00S\x00\x00\x00KDBM\x01\x00\x00\x00 * \x00\x00\x00n\xe7\x1b)X\x10\xb3\xfd\x13y\x9d\xa3\x82]\x0e\xfa:b\x8e\x8fJn\xda`\x9f\xfa\x97T\x08UeF' + * @endcode * * @param pbInput the raw auth blob (base64 and utf16 decoded) * @param cbInput size of pbInput diff --git a/libfreerdp/gdi/drawing.c b/libfreerdp/gdi/drawing.c index d4e241c13..750c878a6 100644 --- a/libfreerdp/gdi/drawing.c +++ b/libfreerdp/gdi/drawing.c @@ -99,7 +99,7 @@ UINT32 gdi_SetBkColor(HGDI_DC hdc, UINT32 crColor) } /** - * @brief Get the current background mode.\n + * @brief Get the current background mode. * msdn{dd144853} * * @param hdc device context @@ -113,7 +113,7 @@ UINT32 gdi_GetBkMode(HGDI_DC hdc) } /** - * @brief Set the current background mode.\n + * @brief Set the current background mode. * msdn{dd162965} * * @param hdc device context diff --git a/winpr/include/winpr/image.h b/winpr/include/winpr/image.h index b267194af..b502b3f6e 100644 --- a/winpr/include/winpr/image.h +++ b/winpr/include/winpr/image.h @@ -82,7 +82,7 @@ typedef struct UINT32 bytesPerPixel; } wImage; -/** @defgroup WINPR_IMAGE_CMP_FLAGS +/** @defgroup WINPR_IMAGE_CMP_FLAGS WINPR_IMAGE_CMP_FLAGS * @since version 3.3.0 * @{ */ @@ -110,7 +110,7 @@ extern "C" * @param data the data of the bitmap without headers * @param stride the byte size of a line in the image * @param width the width in pixels of a line - * @param the height of the bitmap + * @param height the height of the bitmap * @param bpp the color depth of the bitmap * * @since version 3.3.0 @@ -128,7 +128,7 @@ extern "C" /** @brief write a bitmap to a buffer and return it * * @param image the image to write - * @param format the format of type @WINPR_IMAGE_FORMAT + * @param format the format of type @ref WINPR_IMAGE_FORMAT * @param size a pointer to hold the size in bytes of the allocated bitmap * * @since version 3.3.0 @@ -146,7 +146,7 @@ extern "C" /** @brief Check if a image format is supported * - * @param format the format of type @WINPR_IMAGE_FORMAT + * @param format the format of type @ref WINPR_IMAGE_FORMAT * * @since version 3.3.0 * @@ -156,7 +156,7 @@ extern "C" /** @brief Return the file extension of a format * - * @param format the format of type @WINPR_IMAGE_FORMAT + * @param format the format of type @ref WINPR_IMAGE_FORMAT * * @since version 3.3.0 * @@ -166,7 +166,7 @@ extern "C" /** @brief Return the mime type of a format * - * @param format the format of type @WINPR_IMAGE_FORMAT + * @param format the format of type @ref WINPR_IMAGE_FORMAT * * @since version 3.3.0 * @@ -178,7 +178,7 @@ extern "C" * * @param imageA the first image for the comparison * @param imageB the second image for the comparison - * @param flags Comparions flags @WINPR_IMAGE_CMP_FLAGS + * @param flags Comparions flags @ref WINPR_IMAGE_CMP_FLAGS * * @since version 3.3.0 * diff --git a/winpr/include/winpr/json.h b/winpr/include/winpr/json.h index ce9acdf2a..830c86310 100644 --- a/winpr/include/winpr/json.h +++ b/winpr/include/winpr/json.h @@ -25,7 +25,7 @@ #include #include -/** @defgroup WINPR_JSON +/** @defgroup WINPR_JSON WinPR JSON wrapper * @since version 3.6.0 * @brief Wrapper around cJSON or JSONC libraries * @{ @@ -49,7 +49,7 @@ extern "C" WINPR_API int WINPR_JSON_version(char* buffer, size_t len); /** - * @brief Delete a @WINPR_JSON object + * @brief Delete a @ref WINPR_JSON object * * @param item The instance to delete * @since version 3.6.0 @@ -60,7 +60,7 @@ extern "C" * @brief Parse a '\0' terminated JSON string * * @param value A '\0' terminated JSON string - * @return A @WINPR_JSON object holding the parsed string or \b NULL if failed + * @return A @ref WINPR_JSON object holding the parsed string or \b NULL if failed * @since version 3.6.0 */ WINPR_ATTR_MALLOC(WINPR_JSON_Delete, 1) @@ -71,7 +71,7 @@ extern "C" * * @param value A JSON string * @param buffer_length The length in bytes of the JSON string - * @return A @WINPR_JSON object holding the parsed string or \b NULL if failed + * @return A @ref WINPR_JSON object holding the parsed string or \b NULL if failed * @since version 3.6.0 */ WINPR_ATTR_MALLOC(WINPR_JSON_Delete, 1) @@ -100,17 +100,17 @@ extern "C" * @brief Return a pointer to an JSON object item * @param object the JSON object * @param string the name of the object - * @return A pointer to the object identified by @string or \b NULL + * @return A pointer to the object identified by @ref string or \b NULL * @since version 3.6.0 */ WINPR_API WINPR_JSON* WINPR_JSON_GetObjectItem(const WINPR_JSON* object, const char* string); /** - * @brief Same as @WINPR_JSON_GetObjectItem but with case insensitive matching + * @brief Same as @ref WINPR_JSON_GetObjectItem but with case insensitive matching * * @param object the JSON instance to query * @param string the name of the object - * @return A pointer to the object identified by @string or \b NULL + * @return A pointer to the object identified by @ref string or \b NULL * @since version 3.6.0 */ WINPR_API WINPR_JSON* WINPR_JSON_GetObjectItemCaseSensitive(const WINPR_JSON* object, @@ -365,7 +365,7 @@ extern "C" /** * @brief Serialize a JSON instance to string - * for minimal size without formatting see @WINPR_JSON_PrintUnformatted + * for minimal size without formatting see @ref WINPR_JSON_PrintUnformatted * * @param item The JSON instance to serialize * @return A string representation of the JSON instance or \b NULL @@ -375,7 +375,7 @@ extern "C" /** * @brief Serialize a JSON instance to string without formatting - * for human readable formatted output see @WINPR_JSON_Print + * for human readable formatted output see @ref WINPR_JSON_Print * * @param item The JSON instance to serialize * @return A string representation of the JSON instance or \b NULL diff --git a/winpr/include/winpr/thread.h b/winpr/include/winpr/thread.h index 6e61d2855..2c46e37cf 100644 --- a/winpr/include/winpr/thread.h +++ b/winpr/include/winpr/thread.h @@ -197,7 +197,8 @@ extern "C" #define THREAD_MODE_BACKGROUND_BEGIN 0x00010000 /** @since version 3.6.0 */ #define THREAD_MODE_BACKGROUND_END 0x00020000 /** @since version 3.6.0 */ - /** @defgroup THREAD_PRIORITY + /** @defgroup THREAD_PRIORITY THREAD_PRIORITY + * @brief Known THREAD_PRIORITY values * @since version 3.6.0 * @{ */ @@ -210,10 +211,11 @@ extern "C" #define THREAD_PRIORITY_TIME_CRITICAL 15 /** @since version 3.6.0 */ /** @} */ - /** @brief Change the thread priority + /** + * @brief Change the thread priority * * @param hThread the thhread handle to manipulate - * @param nPriority The priority to set, see @THREAD_PRIORITY + * @param nPriority The priority to set, see @ref THREAD_PRIORITY * @return \b TRUE for success, \b FALSE otherwise * @since version 3.6.0 */ diff --git a/winpr/include/winpr/timezone.h b/winpr/include/winpr/timezone.h index 77df18b02..4f9d41418 100644 --- a/winpr/include/winpr/timezone.h +++ b/winpr/include/winpr/timezone.h @@ -57,7 +57,8 @@ extern "C" } DYNAMIC_TIME_ZONE_INFORMATION, *PDYNAMIC_TIME_ZONE_INFORMATION, *LPDYNAMIC_TIME_ZONE_INFORMATION; -/** @defgroup TIME_ZONE_ID +/** @defgroup TIME_ZONE_ID TIME_ZONE_ID + * @brief Known values of TIME_ZONE_ID * @since version 3.6.0 * @{ */