Skip to content

Commit

Permalink
Fixed Doxygen warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
lminiero committed May 2, 2024
1 parent 0b6586f commit fa74bc6
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 13 deletions.
2 changes: 1 addition & 1 deletion src/ice.h
Expand Up @@ -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);
///@}

Expand Down
1 change: 1 addition & 0 deletions src/janus.h
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions src/plugins/plugin.h
Expand Up @@ -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);
///@}

Expand Down
3 changes: 1 addition & 2 deletions src/rtcp.h
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions src/rtpfwd.h
Expand Up @@ -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 */
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/sdp-utils.h
Expand Up @@ -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);

Expand Down
7 changes: 3 additions & 4 deletions src/utils.h
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit fa74bc6

Please sign in to comment.