[documentation] fix Wdocumentation warnings

This commit is contained in:
Armin Novak 2023-10-11 15:05:05 +02:00 committed by akallabeth
parent 2373db233e
commit 53b65ff7bd
5 changed files with 7 additions and 12 deletions

View File

@ -673,12 +673,11 @@ static BOOL freerdp_client_parse_rdp_file_integer(rdpFile* file, const char* nam
return freerdp_client_rdp_file_set_integer(file, name, ivalue);
}
/**
/** set a string value in the provided rdp file context
*
* @param file rdpFile
* @param name name of the string
* @param value value of the string to set
* @param index line index of the rdpFile
* @return 0 on success, 1 if the key wasn't found (not a standard key), -1 on error
*/

View File

@ -86,8 +86,9 @@ extern "C"
/** \brief updates the files the server announces to the client
*
* \param file the file context to update
* \param clip the clipboard instance to use
* \param data the file list [MS-RDPECLIP] 2.2.5.2.3 Packed File List (CLIPRDR_FILELIST)
* \param count the length of the file list
* \param size the length of the file list
*
* \return \b TRUE for success, \b FALSE otherwise
*/

View File

@ -1117,7 +1117,6 @@ static BOOL updateEarlyServerCaps(rdpSettings* settings, UINT32 earlyCapabilityF
* msdn{cc240510}
* @param s stream
* @param mcs The MCS instance
* @param blockLength the length of the block
*
* @return \b TRUE for success, \b FALSE otherwise
*/
@ -1513,7 +1512,6 @@ BOOL gcc_write_server_core_data(wStream* s, rdpMcs* mcs)
* msdn{cc240511}
* @param s stream
* @param mcs MCS instance
* @param blockLength the length of the block
*
* @return \b TRUE for success, \b FALSE otherwise
*/
@ -1929,7 +1927,6 @@ BOOL gcc_write_server_security_data(wStream* s, rdpMcs* mcs)
*
* @param s stream
* @param mcs The MCS instance
* @param blockLength the length of the block
*
* @return \b TRUE for success, \b FALSE otherwise
*/
@ -2085,7 +2082,6 @@ BOOL gcc_write_server_network_data(wStream* s, const rdpMcs* mcs)
* msdn{cc240514}
* @param s stream
* @param mcs The MCS instance
* @param blockLength the length of the block
*
* @return \b TRUE for success, \b FALSE otherwise
*/
@ -2180,7 +2176,6 @@ BOOL gcc_write_client_cluster_data(wStream* s, const rdpMcs* mcs)
* msdn{dd305336}
* @param s stream
* @param mcs The MCS instance
* @param blockLength the lenght of the block
*
* @return \b TRUE for success, \b FALSE otherwise
*/
@ -2462,7 +2457,6 @@ BOOL gcc_write_server_message_channel_data(wStream* s, const rdpMcs* mcs)
* msdn{jj217498}
* @param s stream
* @param mcs The MCS instance
* @param blockLength the length of the block
*
* @return \b TRUE for success, \b FALSE otherwise
*/

View File

@ -1730,7 +1730,7 @@ void nego_enable_ext(rdpNego* nego, BOOL enable_ext)
/**
* Enable RDS AAD security protocol.
* @param nego A pointer to the NEGO struct pointer to the negotiation structure
* @param enable_ext whether to enable RDS AAD Auth protocol (TRUE for
* @param enable_aad whether to enable RDS AAD Auth protocol (TRUE for
* enabled, FALSE for disabled)
*/

View File

@ -919,8 +919,9 @@ SSIZE_T freerdp_certificate_write_server_cert(const rdpCertificate* certificate,
/**
* Read an X.509 Certificate Chain.
* @param certificate certificate module
* @param cert certificate module
* @param s stream
* @return \b TRUE for success, \b FALSE otherwise.
*/
static BOOL certificate_read_server_x509_certificate_chain(rdpCertificate* cert, wStream* s)
@ -1152,7 +1153,7 @@ void certificate_free_int(rdpCertificate* cert)
/**
* Free certificate module.
* @param certificate certificate module to be freed
* @param cert certificate module to be freed
*/
void freerdp_certificate_free(rdpCertificate* cert)