mirror of
https://github.com/morgan9e/FreeRDP
synced 2026-04-15 00:44:19 +09:00
[warnings] fix documentation command unknown
This commit is contained in:
@@ -24,7 +24,9 @@
|
||||
#include <freerdp/dvc.h>
|
||||
#include <freerdp/types.h>
|
||||
|
||||
/** @defgroup channel_location
|
||||
/** @defgroup channel_location Location Channel
|
||||
* @brief Location channel providing redirection of client side Network/GPS location to the RDP
|
||||
* server
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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(
|
||||
|
||||
@@ -30,7 +30,7 @@
|
||||
#include <freerdp/api.h>
|
||||
#include <freerdp/types.h>
|
||||
|
||||
/** @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);
|
||||
|
||||
@@ -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
|
||||
*/
|
||||
|
||||
@@ -26,7 +26,7 @@
|
||||
#include <freerdp/api.h>
|
||||
#include <freerdp/server/proxy/proxy_modules_api.h>
|
||||
|
||||
/** @defgroup proxy_config
|
||||
/** @defgroup proxy_config Proxy Configuration
|
||||
* @ingroup proxy
|
||||
* @{
|
||||
*/
|
||||
|
||||
@@ -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, <old value><separator><param> is created
|
||||
* If the initial value of the setting was not empty, @code <old value><separator><param>
|
||||
* @endcode is created
|
||||
*
|
||||
* \param settings A pointer to the settings to query, must not be NULL.
|
||||
* \param id The key to query
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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 <winpr/wlog.h>
|
||||
|
||||
Reference in New Issue
Block a user