GUACAMOLE-249: Correct missing/incorrect documentation for RDP callback parameters.

This commit is contained in:
Michael Jumper 2019-12-27 23:22:55 -08:00
parent 12febd5162
commit ab05502494
10 changed files with 45 additions and 13 deletions

View File

@ -87,7 +87,7 @@ guac_rdp_clipboard* guac_rdp_clipboard_alloc(guac_client* client);
* The guac_rdp_clipboard instance which has been allocated for the current * The guac_rdp_clipboard instance which has been allocated for the current
* RDP connection. * RDP connection.
* *
* @param rdpContext * @param context
* The rdpContext associated with the FreeRDP side of the RDP connection. * The rdpContext associated with the FreeRDP side of the RDP connection.
*/ */
void guac_rdp_clipboard_load_plugin(guac_rdp_clipboard* clipboard, void guac_rdp_clipboard_load_plugin(guac_rdp_clipboard* clipboard,

View File

@ -177,7 +177,7 @@ struct guac_rdp_common_svc {
* This MUST be called within the PreConnect callback of the freerdp instance * This MUST be called within the PreConnect callback of the freerdp instance
* for static virtual channel support to be loaded. * for static virtual channel support to be loaded.
* *
* @param rdpContext * @param context
* The rdpContext associated with the FreeRDP side of the RDP connection. * The rdpContext associated with the FreeRDP side of the RDP connection.
* *
* @param name * @param name

View File

@ -186,9 +186,9 @@ void guac_rdp_disp_reconnect_complete(guac_rdp_disp* disp);
* Returns whether a full RDP reconnect is required for display update changes * Returns whether a full RDP reconnect is required for display update changes
* to take effect. * to take effect.
* *
* @param client * @param disp
* The guac_client associated with the Guacamole side of the RDP * The display update module that should be checked to determine whether a
* connection. * reconnect is required.
* *
* @return * @return
* Non-zero if a reconnect is needed, zero otherwise. * Non-zero if a reconnect is needed, zero otherwise.

View File

@ -69,7 +69,7 @@ typedef struct guac_rdp_pipe_svc {
* This MUST be called within the PreConnect callback of the freerdp instance * This MUST be called within the PreConnect callback of the freerdp instance
* for static virtual channel support to be loaded. * for static virtual channel support to be loaded.
* *
* @param rdpContext * @param context
* The rdpContext associated with the FreeRDP side of the RDP connection. * The rdpContext associated with the FreeRDP side of the RDP connection.
* *
* @param name * @param name

View File

@ -32,7 +32,7 @@
* This MUST be called within the PreConnect callback of the freerdp instance * This MUST be called within the PreConnect callback of the freerdp instance
* for RAIL support to be loaded. * for RAIL support to be loaded.
* *
* @param rdpContext * @param context
* The rdpContext associated with the FreeRDP side of the RDP connection. * The rdpContext associated with the FreeRDP side of the RDP connection.
*/ */
void guac_rdp_rail_load_plugin(rdpContext* context); void guac_rdp_rail_load_plugin(rdpContext* context);

View File

@ -40,8 +40,8 @@
* Registers a new filesystem device within the RDPDR plugin. This must be done * Registers a new filesystem device within the RDPDR plugin. This must be done
* before RDPDR connection finishes. * before RDPDR connection finishes.
* *
* @param rdpdr * @param svc
* The RDP device redirection plugin with which to register the device. * The static virtual channel instance being used for RDPDR.
* *
* @param drive_name * @param drive_name
* The name of the redirected drive to display in the RDP connection. * The name of the redirected drive to display in the RDP connection.

View File

@ -29,8 +29,8 @@
* Registers a new printer device within the RDPDR plugin. This must be done * Registers a new printer device within the RDPDR plugin. This must be done
* before RDPDR connection finishes. * before RDPDR connection finishes.
* *
* @param rdpdr * @param svc
* The RDP device redirection plugin where the device is registered. * The static virtual channel instance being used for RDPDR.
* *
* @param printer_name * @param printer_name
* The name of the printer that will be registered with the RDP * The name of the printer that will be registered with the RDP

View File

@ -146,7 +146,7 @@ void guac_rdpdr_start_download(guac_rdp_common_svc* svc,
* This MUST be called within the PreConnect callback of the freerdp instance * This MUST be called within the PreConnect callback of the freerdp instance
* for RDPDR support to be loaded. * for RDPDR support to be loaded.
* *
* @param rdpContext * @param context
* The rdpContext associated with the FreeRDP side of the RDP connection. * The rdpContext associated with the FreeRDP side of the RDP connection.
*/ */
void guac_rdpdr_load_plugin(rdpContext* context); void guac_rdpdr_load_plugin(rdpContext* context);

View File

@ -113,7 +113,7 @@ typedef struct guac_rdpsnd {
* This MUST be called within the PreConnect callback of the freerdp instance * This MUST be called within the PreConnect callback of the freerdp instance
* for RDPSND support to be loaded. * for RDPSND support to be loaded.
* *
* @param rdpContext * @param context
* The rdpContext associated with the FreeRDP side of the RDP connection. * The rdpContext associated with the FreeRDP side of the RDP connection.
*/ */
void guac_rdpsnd_load_plugin(rdpContext* context); void guac_rdpsnd_load_plugin(rdpContext* context);

View File

@ -52,6 +52,9 @@ typedef struct guac_rdp_glyph {
* *
* @param glyph * @param glyph
* The glyph to cache. * The glyph to cache.
*
* @return
* TRUE if successful, FALSE otherwise.
*/ */
BOOL guac_rdp_glyph_new(rdpContext* context, const rdpGlyph* glyph); BOOL guac_rdp_glyph_new(rdpContext* context, const rdpGlyph* glyph);
@ -70,6 +73,26 @@ BOOL guac_rdp_glyph_new(rdpContext* context, const rdpGlyph* glyph);
* *
* @param y * @param y
* The destination Y coordinate of the upper-left corner of the glyph. * The destination Y coordinate of the upper-left corner of the glyph.
*
* @param w
* The width of the glyph being drawn.
*
* @param h
* The height of the glyph being drawn.
*
* @param sx
* The X coordinare of the upper-left corner of the glyph within the source
* cache surface containing the glyph.
*
* @param sy
* The Y coordinare of the upper-left corner of the glyph within the source
* cache surface containing the glyph.
*
* @param redundant
* Whether the background rectangle specified is redundant (transparent).
*
* @return
* TRUE if successful, FALSE otherwise.
*/ */
BOOL guac_rdp_glyph_draw(rdpContext* context, const rdpGlyph* glyph, BOOL guac_rdp_glyph_draw(rdpContext* context, const rdpGlyph* glyph,
INT32 x, INT32 y, INT32 w, INT32 h, INT32 sx, INT32 sy, INT32 x, INT32 y, INT32 w, INT32 h, INT32 sx, INT32 sy,
@ -121,6 +144,12 @@ void guac_rdp_glyph_free(rdpContext* context, rdpGlyph* glyph);
* colorspace of the RDP session, and may even be a palette index, and must * colorspace of the RDP session, and may even be a palette index, and must
* be translated via guac_rdp_convert_color(). If the background is * be translated via guac_rdp_convert_color(). If the background is
* transparent, this value is undefined. * transparent, this value is undefined.
*
* @param redundant
* Whether the background rectangle specified is redundant (transparent).
*
* @return
* TRUE if successful, FALSE otherwise.
*/ */
BOOL guac_rdp_glyph_begindraw(rdpContext* context, INT32 x, INT32 y, BOOL guac_rdp_glyph_begindraw(rdpContext* context, INT32 x, INT32 y,
INT32 width, INT32 height, UINT32 fgcolor, UINT32 bgcolor, INT32 width, INT32 height, UINT32 fgcolor, UINT32 bgcolor,
@ -159,6 +188,9 @@ BOOL guac_rdp_glyph_begindraw(rdpContext* context, INT32 x, INT32 y,
* colorspace of the RDP session, and may even be a palette index, and must * colorspace of the RDP session, and may even be a palette index, and must
* be translated via guac_rdp_convert_color(). If the background is * be translated via guac_rdp_convert_color(). If the background is
* transparent, this value is undefined. * transparent, this value is undefined.
*
* @return
* TRUE if successful, FALSE otherwise.
*/ */
BOOL guac_rdp_glyph_enddraw(rdpContext* context, INT32 x, INT32 y, BOOL guac_rdp_glyph_enddraw(rdpContext* context, INT32 x, INT32 y,
INT32 width, INT32 height, UINT32 fgcolor, UINT32 bgcolor); INT32 width, INT32 height, UINT32 fgcolor, UINT32 bgcolor);