sysmocom
/
pjproject
11
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix some doc warning (#2879)

This commit is contained in:
Riza Sulistyo 2021-11-10 09:57:40 +07:00 committed by GitHub
parent 263886b8e0
commit 6ca06f63ec
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
24 changed files with 34 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
pjlib-util/include/pjlib-util/cli.h
View File

@ -289,7 +289,7 @@ typedef void (*pj_cli_get_dyn_choice) (pj_cli_dyn_choice_param *param);
* This specifies the callback type for command handlers, which will be
* executed when the specified command is invoked.
*
* @param cmd_val The command that is specified by the user.
* @param cval The command that is specified by the user.
*
* @return Return the status of the command execution.
*/
@ -390,7 +390,7 @@ PJ_DECL(void) pj_cli_cfg_default(pj_cli_cfg *param);
/**
* Register a front end to the CLI application.
*
* @param CLI The CLI application.
* @param cli The CLI application.
* @param fe The CLI front end to be registered.
*/
PJ_DECL(void) pj_cli_register_front_end(pj_cli_t *cli,

2
pjlib-util/include/pjlib-util/cli_telnet.h
View File

@ -151,7 +151,7 @@ PJ_DECL(pj_status_t) pj_cli_telnet_create(pj_cli_t *cli,
/**
* Retrieve cli telnet info.
*
* @param telnet_info The telnet runtime information.
* @param info The telnet runtime information.
*
* @return PJ_SUCCESS on success.
*/

4
pjlib-util/include/pjlib-util/http_client.h
View File

@ -357,7 +357,7 @@ PJ_DECL(void) pj_http_req_param_default(pj_http_req_param *param);
*
* @param headers The headers.
* @param name The header field name.
* @param value The header field value.
* @param val The header field value.
*
* @return PJ_SUCCESS if the operation has been successful,
* or the appropriate error code on failure.
@ -373,7 +373,7 @@ PJ_DECL(pj_status_t) pj_http_headers_add_elmt(pj_http_headers *headers,
*
* @param headers The headers.
* @param name The header field name.
* @param value The header field value.
* @param val The header field value.
*
* @return PJ_SUCCESS if the operation has been successful,
* or the appropriate error code on failure.

4
pjlib/include/pj/list.h
View File

@ -111,7 +111,6 @@ PJ_INLINE(int) pj_list_empty(const pj_list_type * node)
* @param pos The element to which the node will be inserted before.
* @param node The element to be inserted.
*
* @return void.
*/
PJ_IDECL(void) pj_list_insert_before(pj_list_type *pos, pj_list_type *node);
@ -145,7 +144,6 @@ PJ_IDECL(void) pj_list_insert_nodes_before(pj_list_type *lst,
* element.
* @param node The element to be inserted after the position element.
*
* @return void.
*/
PJ_IDECL(void) pj_list_insert_after(pj_list_type *pos, pj_list_type *node);
@ -185,7 +183,6 @@ PJ_IDECL(void) pj_list_insert_nodes_after(pj_list_type *lst,
* @param list1 The destination list.
* @param list2 The source list.
*
* @return void.
*/
PJ_IDECL(void) pj_list_merge_first(pj_list_type *list1, pj_list_type *list2);
@ -203,7 +200,6 @@ PJ_IDECL(void) pj_list_merge_first(pj_list_type *list1, pj_list_type *list2);
* element.
* @param list2 The element in the list to be inserted.
*
* @return void.
*/
PJ_IDECL(void) pj_list_merge_last( pj_list_type *list1, pj_list_type *list2);

2
pjlib/include/pj/sock.h
View File

@ -1519,7 +1519,7 @@ PJ_DECL(pj_status_t) pj_sock_shutdown( pj_sock_t sockfd,
* @param port The port address.
* @param buf Text buffer.
* @param size Size of buffer.
* @param flags Bitmask combination of these value:
* @param flag Bitmask combination of these value:
* - 1: port number is included.
*
* @return The address string.

12
pjlib/include/pj/ssl_sock.h
View File

@ -250,9 +250,9 @@ PJ_DECL(pj_status_t) pj_ssl_cert_load_from_files2(
* Create credential from data buffer. The certificate expected is in
* PEM format.
*
* @param CA_file The buffer of trusted CA list.
* @param cert_file The buffer of certificate.
* @param privkey_file The buffer of private key.
* @param CA_buf The buffer of trusted CA list.
* @param cert_buf The buffer of certificate.
* @param privkey_buf The buffer of private key.
* @param privkey_pass The password of private key, if any.
* @param p_cert Pointer to credential instance to be created.
*
@ -479,7 +479,7 @@ typedef enum pj_ssl_curve
* Get curve list supported by SSL/TLS backend.
*
* @param curves The curves buffer to receive curve list.
* @param curves_num Maximum number of curves to be received.
* @param curve_num Maximum number of curves to be received.
*
* @return PJ_SUCCESS when successful.
*/
@ -1356,7 +1356,7 @@ PJ_DECL(pj_status_t) pj_ssl_sock_sendto(pj_ssl_sock_t *ssock,
* @param ssock The secure socket.
* @param pool Pool used to allocate some internal data for the
* operation.
* @param localaddr Local address to bind on.
* @param local_addr Local address to bind on.
* @param addr_len Length of buffer containing local address.
*
* @return PJ_SUCCESS if the operation has been successful,
@ -1377,7 +1377,7 @@ PJ_DECL(pj_status_t) pj_ssl_sock_start_accept(pj_ssl_sock_t *ssock,
* @param ssock The secure socket.
* @param pool Pool used to allocate some internal data for the
* operation.
* @param localaddr Local address to bind on.
* @param local_addr Local address to bind on.
* @param addr_len Length of buffer containing local address.
* @param newsock_param Secure socket parameter for new accepted sockets.
*

2
pjmedia/include/pjmedia-codec/amr_helper.h
View File

@ -887,7 +887,7 @@ PJ_INLINE (pj_status_t) pjmedia_codec_amr_pack(
unsigned i, max_pkt_size;
max_pkt_size = *pkt_size;
max_pkt_size = (unsigned)*pkt_size;
if (setting->amr_nb) {
SID_FT = 8;

2
pjmedia/include/pjmedia-videodev/avi_dev.h
View File

@ -113,7 +113,7 @@ PJ_DECL(pj_status_t) pjmedia_avi_dev_alloc(pjmedia_vid_dev_factory *f,
* Retrieve the parameters set for the virtual device.
*
* @param id Device ID.
* @param prm Structure to receive the settings.
* @param param Structure to receive the settings.
*
* @return PJ_SUCCESS or the appropriate error code.
*/

4
pjmedia/include/pjmedia/converter.h
View File

@ -347,10 +347,10 @@ PJ_DECL(pj_status_t) pjmedia_converter_convert(pjmedia_converter *cv,
* @param cv The converter instance.
* @param src_frame The source frame.
* @param src_frame_size The source frame size.
* @param src_reg_pos The source region position.
* @param src_pos The source region position.
* @param dst_frame The destination frame.
* @param dst_frame_size The destination frame size.
* @param dst_reg_pos The destination region position.
* @param dst_pos The destination region position.
* @param param This is unused for now and must be NULL.
*
* @return PJ_SUCCESS if conversion has been performed

2
pjmedia/include/pjmedia/format.h
View File

@ -641,8 +641,6 @@ PJ_INLINE(void) pjmedia_format_init_audio(pjmedia_format *fmt,
* @param height Image heigth.
* @param fps_num FPS numerator.
* @param fps_denum FPS denumerator.
* @param avg_bps Average bitrate.
* @param max_bps Maximum bitrate.
*/
PJ_DECL(void) pjmedia_format_init_video(pjmedia_format *fmt,
pj_uint32_t fmt_id,

2
pjmedia/include/pjmedia/rtcp_fb.h
View File

@ -227,7 +227,6 @@ PJ_DECL(pj_status_t) pjmedia_rtcp_fb_setting_default(
* @param dst Destination configuration.
* @param src Source configuration.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(void) pjmedia_rtcp_fb_setting_dup(pj_pool_t *pool,
pjmedia_rtcp_fb_setting *dst,
@ -241,7 +240,6 @@ PJ_DECL(void) pjmedia_rtcp_fb_setting_dup(pj_pool_t *pool,
* @param dst Destination info.
* @param src Source info.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(void) pjmedia_rtcp_fb_info_dup(pj_pool_t *pool,
pjmedia_rtcp_fb_info *dst,

4
pjmedia/include/pjmedia/sdp.h
View File

@ -348,7 +348,7 @@ typedef struct pjmedia_sdp_ssrc_attr
*
* @param attr Generic attribute to be converted to ssrc, which
* name must be "ssrc".
* @param ssrc SDP ssrc attribute to be initialized.
* @param rtcp SDP ssrc attribute to be initialized.
*
* @return PJ_SUCCESS on success.
*/
@ -408,7 +408,7 @@ PJ_DECL(pjmedia_sdp_conn*) pjmedia_sdp_conn_clone(pj_pool_t *pool,
* Compare connection info.
*
* @param conn1 The first connection info to compare.
* @param conn1 The second connection info to compare.
* @param conn2 The second connection info to compare.
* @param option Comparison option, which should be zero for now.
*
* @return PJ_SUCCESS when both connection info are equal, otherwise

2
pjmedia/include/pjmedia/sound.h
View File

@ -123,7 +123,7 @@ typedef pj_status_t (*pjmedia_snd_play_cb)(/* in */ void *user_data,
*
* @param user_data User data associated with the stream.
* @param timestamp Timestamp, in samples.
* @param output Buffer containing the captured audio samples.
* @param input Buffer containing the captured audio samples.
* @param size The size of the data in the buffer, in bytes.
*
* @return Non-zero to stop the stream.

2
pjmedia/include/pjmedia/transport_srtp.h
View File

@ -351,7 +351,7 @@ PJ_DECL(pj_status_t) pjmedia_srtp_enum_crypto(unsigned *count,
* @param count On input, specifies the maximum length of keying method
* array. On output, the number of available keying method
* initialized by this function.
* @param crypto The SRTP keying method array output.
* @param keying The SRTP keying method array output.
*
* @return PJ_SUCCESS on success.
*/

1
pjmedia/include/pjmedia/vid_codec.h
View File

@ -610,7 +610,6 @@ pjmedia_vid_codec_mgr_get_default_param(pjmedia_vid_codec_mgr *mgr,
*
* @param mgr The codec manager instance. If NULL, the default codec
* manager instance will be used.
* @param pool The pool instance.
* @param info The codec info, which default parameter's is being
* updated.
* @param param The new default codec parameter. Set to NULL to reset

6
pjmedia/include/pjmedia/vid_conf.h
View File

@ -222,7 +222,7 @@ PJ_DECL(unsigned) pjmedia_vid_conf_get_port_count(pjmedia_vid_conf *vid_conf);
/**
* Enumerate occupied slots in the video conference bridge.
*
* @param conf The video conference bridge.
* @param vid_conf The video conference bridge.
* @param slots Array of slot to be filled in.
* @param count On input, specifies the maximum number of slot
* in the array. On return, it will be filled with
@ -254,7 +254,7 @@ PJ_DECL(pj_status_t) pjmedia_vid_conf_get_port_info(
* Enable unidirectional video flow from the specified source slot to
* the specified sink slot.
*
* @param conf The video conference bridge.
* @param vid_conf The video conference bridge.
* @param src_slot Source slot.
* @param sink_slot Sink slot.
* @param opt The option, for future use, currently this must
@ -273,7 +273,7 @@ PJ_DECL(pj_status_t) pjmedia_vid_conf_connect_port(
* Disconnect unidirectional video flow from the specified source to
* the specified sink slot.
*
* @param conf The video conference bridge.
* @param vid_conf The video conference bridge.
* @param src_slot Source slot.
* @param sink_slot Sink slot.
*

1
pjnath/include/pjnath/stun_session.h
View File

@ -748,7 +748,6 @@ PJ_DECL(pj_status_t) pj_stun_session_on_rx_pkt(pj_stun_session *sess,
* @param sess The STUN session.
* @param tdata The transmit data.
*
* @return PJ_SUCCESS on success, or the appropriate error code.
*/
PJ_DECL(void) pj_stun_msg_destroy_tdata(pj_stun_session *sess,
pj_stun_tx_data *tdata);

2
pjsip/include/pjsip/sip_dialog.h
View File

@ -302,7 +302,7 @@ PJ_DECL(pj_status_t) pjsip_dlg_create_uac( pjsip_user_agent *ua,
*
* See \a pjsip_dlg_create_uac() for general info about this function.
*
* @param param The parameter, refer to
* @param create_param The parameter, refer to
* \a pjsip_dlg_create_uac_param
* @param p_dlg Pointer to receive the dialog.
*

2
pjsip/include/pjsip/sip_endpoint.h
View File

@ -437,7 +437,7 @@ PJ_DECL(pj_status_t) pjsip_endpt_set_resolver(pjsip_endpoint *endpt,
* PJLIB-UTIL DNS resolver if any (e.g: set using #pjsip_endpt_set_resolver()).
* Application that needs it, still be able create its own instance.
*
* @param res The SIP resolver engine.
* @param endpt The SIP resolver engine.
* @param ext_res The external resolver implementation callback. This argument
* can be NULL to reset the whole external implementation.
* However, it is prohibited to reset individual callback.

1
pjsip/include/pjsip/sip_msg.h
View File

@ -1075,7 +1075,6 @@ pjsip_generic_string_hdr_init( pj_pool_t *pool,
* assign the header name with some string.
* @param hvalue Optional string to be assigned as the value.
*
* @return The header, or THROW exception.
*/
PJ_DECL(void) pjsip_generic_string_hdr_init2(pjsip_generic_string_hdr *h,
pj_str_t *hname,

2
pjsip/include/pjsip/sip_transport.h
View File

@ -1247,7 +1247,7 @@ PJ_DECL(void) pjsip_tpmgr_fla2_param_default(pjsip_tpmgr_fla2_param *prm);
*
* @param tpmgr The transport manager.
* @param pool Pool to allocate memory for the IP address.
* @param param Function input and output parameters.
* @param prm Function input and output parameters.
*
* @return PJ_SUCCESS, or the appropriate error code.
*/

2
pjsip/include/pjsip/sip_util.h
View File

@ -207,7 +207,7 @@ PJ_DECL(pj_status_t) pjsip_target_set_set_current(pjsip_target_set *tset,
*
* @param target The target.
* @param pool The memory pool to be used to duplicate the reason phrase.
* @param code The SIP status code to be set to the target.
* @param status_code The SIP status code to be set to the target.
* @param reason The reason phrase to be set to the target.
*
* @return PJ_SUCCESS on successful operation or the appropriate

10
pjsip/include/pjsua-lib/pjsua.h
View File

@ -6041,7 +6041,7 @@ PJ_DECL(pj_status_t) pjsua_call_get_stream_info(pjsua_call_id call_id,
*
* @param call_id The call identification.
* @param med_idx Media stream index.
* @param psi To be filled with the stream statistic.
* @param stat To be filled with the stream statistic.
*
* @return PJ_SUCCESS on success or the appropriate error.
*/
@ -7458,7 +7458,7 @@ PJ_DECL(pj_status_t) pjsua_player_get_port(pjsua_player_id id,
* Get additional info about the file player. This operation is not valid
* for playlist.
*
* @param port The file player ID.
* @param id The file player ID.
* @param info The info.
*
* @return PJ_SUCCESS on success or the appropriate error code.
@ -7809,7 +7809,7 @@ typedef struct pjsua_ext_snd_dev pjsua_ext_snd_dev;
/**
* Create an extra sound device and register it to conference bridge.
*
* @param snd_param Sound device port param. Currently this only supports
* @param param Sound device port param. Currently this only supports
* mono channel, so channel count must be set to 1.
* @param p_snd The extra sound device instance.
*
@ -7822,7 +7822,7 @@ PJ_DECL(pj_status_t) pjsua_ext_snd_dev_create(pjmedia_snd_port_param *param,
/**
* Destroy an extra sound device and unregister it from conference bridge.
*
* @param p_snd The extra sound device instance.
* @param snd The extra sound device instance.
*
* @return PJ_SUCCESS on success or the appropriate error code.
*/
@ -8260,7 +8260,7 @@ typedef struct pjsua_vid_win_info
/**
* Enumerates all video windows.
*
* @param id Array of window ID to be initialized.
* @param wids Array of window ID to be initialized.
* @param count On input, specifies max elements in the array.
* On return, it contains actual number of elements
* that have been initialized.

4
pjsip/include/pjsua-lib/pjsua_internal.h
View File

@ -755,7 +755,7 @@ pj_status_t call_media_on_event(pjmedia_event *event,
/**
* Init presence.
*/
pj_status_t pjsua_pres_init();
pj_status_t pjsua_pres_init(void);
/*
* Start presence subsystem.
@ -904,7 +904,7 @@ pj_status_t pjsua_aud_channel_update(pjsua_call_media *call_med,
pjmedia_stream_info *si,
const pjmedia_sdp_session *local_sdp,
const pjmedia_sdp_session *remote_sdp);
void pjsua_check_snd_dev_idle();
void pjsua_check_snd_dev_idle(void);
/*
* Video