From fa74bc6ca8a2f54e0397b7727c11266eb43886df Mon Sep 17 00:00:00 2001 From: Lorenzo Miniero Date: Thu, 2 May 2024 16:23:22 +0200 Subject: [PATCH] Fixed Doxygen warnings --- src/ice.h | 2 +- src/janus.h | 1 + src/plugins/plugin.h | 3 +-- src/rtcp.h | 3 +-- src/rtpfwd.h | 6 +++--- src/sdp-utils.h | 2 +- src/utils.h | 7 +++---- 7 files changed, 11 insertions(+), 13 deletions(-) diff --git a/src/ice.h b/src/ice.h index df98cf5e75..c0557f6a55 100644 --- a/src/ice.h +++ b/src/ice.h @@ -700,7 +700,7 @@ gint janus_ice_handle_destroy(void *core_session, janus_ice_handle *handle); * @param[in] reason A description of why this happened */ void janus_ice_webrtc_hangup(janus_ice_handle *handle, const char *reason); /*! \brief Method to only free resources related to a specific Webrtc PeerConnection allocated by a Janus ICE handle - * @param[in] component The Janus ICE component instance to free */ + * @param[in] pc The Janus ICE component instance to free */ void janus_ice_peerconnection_destroy(janus_ice_peerconnection *pc); ///@} diff --git a/src/janus.h b/src/janus.h index bc0385cde4..7d05decb84 100644 --- a/src/janus.h +++ b/src/janus.h @@ -140,6 +140,7 @@ struct janus_request { * @param[in] request_id Opaque pointer to the request ID, if available * @param[in] admin Whether this is a Janus API or Admin API request * @param[in] message Opaque pointer to the original request, if available + * @param[in] error If the transport detected a JSON parsing error, the error content * @returns A pointer to a janus_request instance if successful, NULL otherwise */ janus_request *janus_request_new(janus_transport *transport, janus_transport_session *instance, void *request_id, gboolean admin, json_t *message, json_error_t *error); /*! \brief Helper to destroy a janus_request instance diff --git a/src/plugins/plugin.h b/src/plugins/plugin.h index d8ab6d2b40..686a8db63f 100644 --- a/src/plugins/plugin.h +++ b/src/plugins/plugin.h @@ -499,8 +499,7 @@ struct janus_plugin_result { janus_plugin_result *janus_plugin_result_new(janus_plugin_result_type type, const char *text, json_t *content); /*! \brief Helper to quickly destroy a janus_plugin_result instance - * @param[in] result The janus_plugin_result instance to destroy - * @returns A valid janus_plugin_result instance, if successful, or NULL otherwise */ + * @param[in] result The janus_plugin_result instance to destroy */ void janus_plugin_result_destroy(janus_plugin_result *result); ///@} diff --git a/src/rtcp.h b/src/rtcp.h index 3c49064445..85a3edbdc0 100644 --- a/src/rtcp.h +++ b/src/rtcp.h @@ -329,8 +329,7 @@ uint32_t janus_rtcp_context_get_out_media_link_quality(janus_rtcp_context *ctx); /*! \brief Method to swap Report Blocks and move media RB in first position in case rtx SSRC comes first * @param[in] packet The message data * @param[in] len The message data length in bytes - * @param[in] rtx_ssrc The rtx SSRC - * @returns The receiver SSRC, or 0 in case of error */ + * @param[in] rtx_ssrc The rtx SSRC */ void janus_rtcp_swap_report_blocks(char *packet, int len, uint32_t rtx_ssrc); /*! \brief Method to quickly retrieve the sender SSRC (needed for demuxing RTCP in BUNDLE) * @param[in] packet The message data diff --git a/src/rtpfwd.h b/src/rtpfwd.h index f0bcf5bcb4..c0f8afaf93 100644 --- a/src/rtpfwd.h +++ b/src/rtpfwd.h @@ -20,10 +20,10 @@ #include "rtpsrtp.h" -/* \brief RTP forwarders code initialization +/*! \brief RTP forwarders code initialization * @returns 0 in case of success, a negative integer on errors */ int janus_rtp_forwarders_init(void); -/* \brief RTP forwarders code de-initialization */ +/*! \brief RTP forwarders code de-initialization */ void janus_rtp_forwarders_deinit(void); /*! \brief Helper struct for implementing RTP forwarders */ @@ -82,7 +82,7 @@ typedef struct janus_rtp_forwarder { } janus_rtp_forwarder; /*! \brief Helper method to create a new janus_rtp_forwarder instance * @param[in] ctx The context of this forwarder (e.g., the plugin name) - * @param[in] id The unique forwarder ID to assign as part of the context (0=autogenerate) + * @param[in] stream_id The unique forwarder ID to assign as part of the context (0=autogenerate) * @param[in] udp_fd The socket to use for sending RTP packets * @param[in] host The address to forward the RTP packets to * @param[in] port The port to forward the RTP packets to diff --git a/src/sdp-utils.h b/src/sdp-utils.h index 8cdc4e6f24..b954ce0ba2 100644 --- a/src/sdp-utils.h +++ b/src/sdp-utils.h @@ -406,7 +406,7 @@ int janus_sdp_get_codec_pt_full(janus_sdp *sdp, int index, const char *codec, co const char *janus_sdp_get_codec_name(janus_sdp *sdp, int index, int pt); /*! \brief Helper to get the codec name associated to a specific rtpmap - * @param codec The rtpmap, as a string (e.g., "VP8/90000") + * @param rtpmap The rtpmap, as a string (e.g., "VP8/90000") * @returns The codec name, if found (e.g., "vp8"), or NULL otherwise */ const char *janus_sdp_get_rtpmap_codec(const char *rtpmap); diff --git a/src/utils.h b/src/utils.h index 93898d22e7..4630a1b6c4 100644 --- a/src/utils.h +++ b/src/utils.h @@ -234,8 +234,7 @@ void janus_protected_folders_clear(void); /*! \brief Creates a string describing the JSON type and constraint * @param jtype The JSON type, e.g., JSON_STRING * @param flags Indicates constraints for the described type - * @param[out] type_name The type description, e.g., "a positive integer"; required size is 19 characters - * @returns 0 if successful, a negative integer otherwise */ + * @param[out] type_name The type description, e.g., "a positive integer"; required size is 19 characters */ void janus_get_json_type_name(int jtype, unsigned int flags, char *type_name); /*! \brief Checks whether the JSON value matches the type and constraint @@ -472,12 +471,12 @@ void janus_set3(guint8 *data, size_t i, guint32 val); */ void janus_set4(guint8 *data, size_t i, guint32 val); -/* \brief Helpers to read a bit from a bitstream +/*! \brief Helpers to read a bit from a bitstream * @param[in] base Pointer to the start of the bitstream * @param[in] offset Offset in bits from the start * @returns The value of the bit */ uint8_t janus_bitstream_getbit(uint8_t *base, uint32_t offset); -/* \brief Helpers to read agroup of bits from a bitstream +/*! \brief Helpers to read agroup of bits from a bitstream * @param[in] base Pointer to the start of the bitstream * @param[in] num The number of bits to read * @param[in] offset Offset in bits from the start