Merge pull request #101 from glyptodon/doxygen-warnings

GUAC-1434: Fix Doxygen warnings.
This commit is contained in:
James Muehlner 2015-12-15 16:30:59 -08:00
commit e2ecdbdcf6
4 changed files with 73 additions and 1549 deletions

File diff suppressed because it is too large Load Diff

View File

@ -147,9 +147,23 @@ guac_audio_stream* guac_audio_stream_alloc(guac_client* client,
* sample are all identical to the current settings, this function has no
* effect.
*
* @param audio
* The guac_audio_stream to reset.
*
* @param encoder
* The guac_audio_encoder to use when encoding audio, or NULL to leave this
* unchanged.
*
* @param rate
* The number of samples per second of PCM data sent to this stream.
*
* @param channels
* The number of audio channels per sample of PCM data. Legal values are
* 1 or 2.
*
* @param bps
* The number of bits per sample per channel for PCM data. Legal values are
* 8 or 16.
*/
void guac_audio_stream_reset(guac_audio_stream* audio,
guac_audio_encoder* encoder, int rate, int channels, int bps);

View File

@ -486,11 +486,18 @@ void guac_client_free(guac_client* client);
* initial handler lookup table defined in client-handlers.c. The intial
* handlers will in turn call the client's handler (if defined).
*
* @param client The proxy client whose handlers should be called.
* @param instruction The instruction to pass to the proxy client via the
* appropriate handler.
* @param client
* The proxy client whose handlers should be called.
*
* @param instruction
* The instruction to pass to the proxy client via the appropriate handler.
*
* @return
* Non-negative if the instruction was handled successfully, or negative
* if an error occurred.
*/
int guac_client_handle_instruction(guac_client* client, guac_instruction* instruction);
int guac_client_handle_instruction(guac_client* client,
guac_instruction* instruction);
/**
* Writes a message in the log used by the given client. The logger used will

View File

@ -130,10 +130,19 @@ int guac_protocol_send_log(guac_socket* socket, const char* format, ...);
* If an error occurs sending the instruction, a non-zero value is
* returned, and guac_error is set appropriately.
*
* @param socket The guac_socket connection to use.
* @param format A printf-style format string to log.
* @param ap The va_list containing the arguments to be used when filling the
* format string for printing.
* @param socket
* The guac_socket connection to use.
*
* @param format
* A printf-style format string to log.
*
* @param args
* The va_list containing the arguments to be used when filling the
* format string for printing.
*
* @return
* Zero if the instruction was sent successfully, non-zero if an error
* occurs.
*/
int vguac_protocol_send_log(guac_socket* socket, const char* format,
va_list args);
@ -626,6 +635,9 @@ int guac_protocol_send_lstroke(guac_socket* socket,
* @param layer
* The destination layer.
*
* @param mimetype
* The mimetype of the image data being sent.
*
* @param x
* The X coordinate of the upper-left corner of the destination rectangle
* within the destination layer, in pixels.