github/xrdp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #2831 from firewave/wdoc

Browse Source 
mitigated `-Wdocumentation` and `-Wdocumentation-unknown-command` Clang compiler warnings
This commit is contained in:
matt335672
2025-11-06 11:21:40 +00:00
committed by GitHub
parent 0bf09425c5 7583e192e7
commit 4b87cfc08f
48 changed files with 95 additions and 152 deletions
Download Patch File Download Diff File Expand all files Collapse all files
sesman/chansrv/chansrv_config.c
+8 -8
View File
@@ -81,8 +81,8 @@ log_to_stdout(const enum logLevels lvl, const char *msg, ...)
*
* @param logmsg Function to use to log messages
* @param names List of definitions in the section
* @params values List of corresponding values for the names
* @params cfg Pointer to structure we're filling in
* @param values List of corresponding values for the names
* @param cfg Pointer to structure we're filling in
*
* @return 0 for success
*/
@@ -136,8 +136,8 @@ read_config_globals(log_func_t logmsg,
*
* @param logmsg Function to use to log messages
* @param names List of definitions in the section
* @params values List of corresponding values for the names
* @params cfg Pointer to structure we're filling in
* @param values List of corresponding values for the names
* @param cfg Pointer to structure we're filling in
*
* @return 0 for success
*/
@@ -189,8 +189,8 @@ read_config_security(log_func_t logmsg,
*
* @param logmsg Function to use to log messages
* @param names List of definitions in the section
* @params values List of corresponding values for the names
* @params cfg Pointer to structure we're filling in
* @param values List of corresponding values for the names
* @param cfg Pointer to structure we're filling in
*
* @return 0 for success
*/
@@ -279,8 +279,8 @@ read_config_chansrv(log_func_t logmsg,
*
* @param logmsg Function to use to log messages
* @param names List of definitions in the section
* @params values List of corresponding values for the names
* @params cfg Pointer to structure we're filling in
* @param values List of corresponding values for the names
* @param cfg Pointer to structure we're filling in
*
* @return 0 for success
*/
sesman/chansrv/chansrv_config.h
+2 -2
View File
@@ -79,7 +79,7 @@ config_read(int use_logger, const char *sesman_ini);
/**
*
* @brief Dumps configuration to stdout
* @param pointer to a config_chansrv struct
* @param config pointer to a config_chansrv struct
*
*/
void
@@ -88,7 +88,7 @@ config_dump(struct config_chansrv *config);
/**
*
* @brief Frees configuration allocated by config_read()
* @param pointer to a config_chansrv struct (may be NULL)
* @param cs pointer to a config_chansrv struct (may be NULL)
*
*/
void
sesman/chansrv/chansrv_fuse.c
+1 -1
View File
@@ -1,7 +1,7 @@
/**
* xrdp: A Remote Desktop Protocol server.
*
* Copyright (C) Laxmikant Rashinkar 2013 LK.Rashinkar@gmail.com
* Copyright (C) Laxmikant Rashinkar 2013 LK.Rashinkar\@gmail.com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
sesman/chansrv/clipboard_common.h
+1 -1
View File
@@ -69,7 +69,7 @@ struct clip_file_desc /* CLIPRDR_FILEDESCRIPTOR */
* Input a terminated UTF-16 string from a stream as UTF-8.
* @param s stream
* @param text UTF-8 String buffer
* @param text_len Length of above
* @param num_chars Length of above
* @return number of bytes copied from stream
*/
unsigned int
sesman/chansrv/clipboard_file.h
+1 -1
View File
@@ -35,7 +35,7 @@ clipboard_process_file_response(struct stream *s, int clip_msg_status,
*
* Files in the list are added to the xfs filesystem in the clipboard
* directory. The filenames names are added to the 'file_list' for the user.
* Files are prefixed with '<fprefix><clipboard_dir>/' and separated by '\n'.
* Files are prefixed with '<fprefix><clipboard_dir>/' and separated by '\\n'.
*
* If the list is not big enough, whole filenames are omitted, and a warning
* message is logged. This is not an error.
sesman/chansrv/devredir.c
-1
View File
@@ -1441,7 +1441,6 @@ devredir_get_dir_listing(struct state_dirscan *fusep, tui32 device_id,
* @param fusep opaque data struct that we just pass back to FUSE when done
* @param device_id device_id of the redirected share
* @param path the name of the directory containing the file
* @param file the filename
*
* @return 0 on success, -1 on failure
*****************************************************************************/
sesman/chansrv/smartcard.c
-18
View File
@@ -452,7 +452,6 @@ scard_send_list_readers(void *user_data, char *context, int context_bytes,
/**
* Send get change in status command
*
* @param con connection to client
* @param wide TRUE if unicode string
* @param timeout timeout in milliseconds, -1 for infinity
* @param num_readers number of entries in rsa
@@ -488,7 +487,6 @@ scard_send_get_status_change(void *user_data, char *context, int context_bytes,
/**
* Open a connection to the smart card located in the reader
*
* @param con connection to client
* @param wide TRUE if unicode string
*****************************************************************************/
int
@@ -520,8 +518,6 @@ scard_send_connect(void *user_data, char *context, int context_bytes,
* The reconnect method re-establishes a smart card reader handle. On success,
* the handle is valid once again.
*
* @param con connection to client
* @param sc_handle handle to device
* @param rs reader state where following fields are set
* rs.shared_mode_flag
* rs.preferred_protocol
@@ -556,7 +552,6 @@ scard_send_reconnect(void *user_data, char *context, int context_bytes,
* Lock smart card reader for exclusive access for specified smart
* card reader handle.
*
* @param con connection to client
*****************************************************************************/
int
scard_send_begin_transaction(void *user_data, char *context, int context_bytes,
@@ -587,8 +582,6 @@ scard_send_begin_transaction(void *user_data, char *context, int context_bytes,
* Release a smart card reader after being locked by a previously
* successful call to Begin Transaction
*
* @param con connection to client
* @param sc_handle handle to smartcard
*****************************************************************************/
int
scard_send_end_transaction(void *user_data, char *context, int context_bytes,
@@ -620,7 +613,6 @@ scard_send_end_transaction(void *user_data, char *context, int context_bytes,
/**
* Get the status of a connection for a valid smart card reader handle
*
* @param con connection to client
* @param wide TRUE if unicode string
*****************************************************************************/
int
@@ -653,8 +645,6 @@ scard_send_status(void *user_data, int wide, char *context, int context_bytes,
/**
* Release a smart card reader handle that was acquired in ConnectA/ConnectW
*
* @param con connection to client
* @param sc_handle handle to smartcard
*****************************************************************************/
int
scard_send_disconnect(void *user_data, char *context, int context_bytes,
@@ -1584,8 +1574,6 @@ scard_send_Connect(IRP *irp, char *context, int context_bytes,
* The reconnect method re-establishes a smart card reader handle. On success,
* the handle is valid once again.
*
* @param con connection to client
* @param sc_handle handle to device
* @param rs reader state where following fields are set
* rs.shared_mode_flag
* rs.preferred_protocol
@@ -1660,7 +1648,6 @@ scard_send_Reconnect(IRP *irp, char *context, int context_bytes,
* Lock smart card reader for exclusive access for specified smart
* card reader handle.
*
* @param con connection to client
*****************************************************************************/
static void
scard_send_BeginTransaction(IRP *irp, char *context, int context_bytes,
@@ -1726,8 +1713,6 @@ scard_send_BeginTransaction(IRP *irp, char *context, int context_bytes,
* Release a smart card reader after being locked by a previously
* successful call to Begin Transaction
*
* @param con connection to client
* @param sc_handle handle to smartcard
*****************************************************************************/
static void
scard_send_EndTransaction(IRP *irp, char *context, int context_bytes,
@@ -1793,7 +1778,6 @@ scard_send_EndTransaction(IRP *irp, char *context, int context_bytes,
/**
* Get the status of a connection for a valid smart card reader handle
*
* @param con connection to client
* @param wide TRUE if unicode string
*****************************************************************************/
static void
@@ -1881,8 +1865,6 @@ scard_send_Status(IRP *irp, int wide, char *context, int context_bytes,
/**
* Release a smart card reader handle that was acquired in ConnectA/ConnectW
*
* @param con connection to client
* @param sc_handle handle to smartcard
*****************************************************************************/
static void
scard_send_Disconnect(IRP *irp, char *context, int context_bytes,