[asterisk-bugs] [JIRA] (ASTERISK-29747) res_pjsip: Fix for Doxygen
Joshua C. Colp (JIRA)
noreply at issues.asterisk.org
Tue Nov 16 03:55:49 CST 2021
[ https://issues.asterisk.org/jira/browse/ASTERISK-29747?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Joshua C. Colp updated ASTERISK-29747:
--------------------------------------
Status: Open (was: Triage)
> res_pjsip: Fix for Doxygen
> --------------------------
>
> Key: ASTERISK-29747
> URL: https://issues.asterisk.org/jira/browse/ASTERISK-29747
> Project: Asterisk
> Issue Type: Bug
> Security Level: None
> Components: Documentation, Resources/res_pjsip, Resources/res_pjsip_authenticator_digest, Resources/res_pjsip_caller_id, Resources/res_pjsip_config_wizard, Resources/res_pjsip_messaging, Resources/res_pjsip_outbound_authenticator_digest, Resources/res_pjsip_outbound_registration, Resources/res_pjsip_path, Resources/res_pjsip_publish_asterisk, Resources/res_pjsip_pubsub, Resources/res_pjsip_registrar, Resources/res_pjsip_sdp_rtp, Resources/res_pjsip_session
> Affects Versions: 16.22.0, 18.8.0, 19.0.0
> Reporter: Alexander Traud
> Severity: Trivial
>
> If all {{WARN_}} are enabled in the file {{doc/asterisk-ng-doxygen.in}}, the following appears in the file {{doxygen.log}}:
> {code}
> res/res_pjsip_history.c:775: warning: unable to resolve reference to 'vector_history' for \ref command
> res/res_pjsip_history.c:76: warning: unable to resolve reference to 'vector_history' for \ref command
> res/res_pjsip/config_global.c:388: warning: documented empty return type of ast_sip_get_default_from_user
> res/res_pjsip/config_global.c:375: warning: documented empty return type of ast_sip_get_default_realm
> res/res_pjsip/config_global.c:570: warning: documented empty return type of global_loaded_observer
> res/res_pjsip/config_transport.c:1345: warning: argument 'transport' of command @param is not found in the argument list of transport_localnet_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
> res/res_pjsip/config_transport.c:1345: warning: argument 'name' of command @param is not found in the argument list of transport_localnet_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
> res/res_pjsip/config_transport.c:1346: warning: The following parameters of transport_localnet_handler(const struct aco_option *opt, struct ast_variable *var, void *obj) are not documented:
> parameter 'opt'
> parameter 'var'
> parameter 'obj'
> res/res_pjsip/pjsip_cli.c:36: warning: The following parameter of ast_sip_cli_print_sorcery_objectset(void *obj, void *arg, int flags) is not documented:
> parameter 'flags'
> include/asterisk/res_pjsip_cli.h:76: warning: argument 'name' of command @param is not found in the argument list of ast_sip_register_cli_formatter(struct ast_sip_cli_formatter_entry *formatter)
> include/asterisk/res_pjsip_cli.h:85: warning: argument 'name' of command @param is not found in the argument list of ast_sip_unregister_cli_formatter(struct ast_sip_cli_formatter_entry *formatter)
> res/res_pjsip/pjsip_cli.c:326: warning: The following parameter of ast_sip_unregister_cli_formatter(struct ast_sip_cli_formatter_entry *formatter) is not documented:
> parameter 'formatter'
> include/asterisk/res_pjsip.h:970: warning: argument 'array' of command @param is not found in the argument list of ast_sip_auth_vector_destroy(struct ast_sip_auth_vector *vector)
> res/res_pjsip/pjsip_configuration.c:249: warning: The following parameter of ast_sip_auth_vector_destroy(struct ast_sip_auth_vector *vector) is not documented:
> parameter 'vector'
> include/asterisk/res_pjsip.h:2834: warning: argument 'str' of command @param is not found in the argument list of ast_sip_sorcery_object_to_ami(const void *obj, struct ast_str **buf)
> res/res_pjsip/pjsip_configuration.c:1647: warning: The following parameter of ast_sip_sorcery_object_to_ami(const void *obj, struct ast_str **buf) is not documented:
> parameter 'buf'
> res/res_pjsip/pjsip_distributor.c:1225: warning: documented empty return type of distributor_pool_shutdown
> res/res_pjsip/pjsip_global_headers.c:181: warning: documented empty return type of ast_sip_destroy_global_headers
> res/res_pjsip/pjsip_global_headers.c:163: warning: documented empty return type of ast_sip_initialize_global_headers
> include/asterisk/res_pjsip_session_caps.h:25: warning: argument 'codec_prefs' of command @param is not found in the argument list of ast_sip_create_joint_call_cap(const struct ast_format_cap *remote, struct ast_format_cap *local, enum ast_media_type media_type, struct ast_flags codec_pref)
> res/res_pjsip_session/pjsip_session_caps.c:65: warning: The following parameter of ast_sip_create_joint_call_cap(const struct ast_format_cap *remote, struct ast_format_cap *local, enum ast_media_type media_type, struct ast_flags codec_pref) is not documented:
> parameter 'codec_pref'
> res/res_pjsip/pjsip_transport_events.c:277: warning: documented empty return type of ast_sip_transport_monitor_unregister
> res/res_pjsip/pjsip_transport_events.c:257: warning: documented empty return type of ast_sip_transport_monitor_unregister_all
> res/res_pjsip/pjsip_transport_events.c:366: warning: documented empty return type of ast_sip_transport_state_register
> res/res_pjsip/pjsip_transport_events.c:359: warning: documented empty return type of ast_sip_transport_state_unregister
> res/res_pjsip/pjsip_transport_events.c:127: warning: documented empty return type of transport_state_do_reg_callbacks
> res/res_pjsip/include/res_pjsip_private.h:385: warning: Found unknown command '\r'
> res/res_pjsip/presence_xml.c:84: warning: The following parameter of ast_sip_presence_exten_state_to_str(int state, char **statestring, char **pidfstate, char **pidfnote, enum ast_sip_pidf_state *local_state, unsigned int notify_early_inuse_ringing) is not documented:
> parameter 'notify_early_inuse_ringing'
> res/res_pjsip/presence_xml.c:172: warning: documented empty return type of ast_sip_presence_xml_find_node_attr
> res/res_pjsip.c:5135: warning: The following parameter of ast_sip_add_body_multipart(pjsip_tx_data *tdata, const struct ast_sip_body *bodies[], int num_bodies) is not documented:
> parameter 'num_bodies'
> include/asterisk/res_pjsip.h:2445: warning: argument 'body' of command @param is not found in the argument list of ast_sip_append_body(pjsip_tx_data *tdata, const char *body_text)
> res/res_pjsip.c:5151: warning: The following parameter of ast_sip_append_body(pjsip_tx_data *tdata, const char *body_text) is not documented:
> parameter 'body_text'
> include/asterisk/res_pjsip.h:2168: warning: argument 'out' of command @param is not found in the argument list of ast_sip_create_rdata(pjsip_rx_data *rdata, char *packet, const char *src_name, int src_port, char *transport_type, const char *local_name, int local_port)
> include/asterisk/res_pjsip.h:2146: warning: argument 'out' of command @param is not found in the argument list of ast_sip_create_rdata_with_contact(pjsip_rx_data *rdata, char *packet, const char *src_name, int src_port, char *transport_type, const char *local_name, int local_port, const char *contact_uri)
> include/asterisk/res_pjsip.h:2272: warning: argument 'tdata' of command @param is not found in the argument list of ast_sip_create_response(const pjsip_rx_data *rdata, int st_code, struct ast_sip_contact *contact, pjsip_tx_data **p_tdata)
> res/res_pjsip.c:5485: warning: The following parameter of ast_sip_create_response(const pjsip_rx_data *rdata, int st_code, struct ast_sip_contact *contact, pjsip_tx_data **p_tdata) is not documented:
> parameter 'p_tdata'
> res/res_pjsip.c:3736: warning: argument 'endpoint' from the argument list of ast_sip_format_endpoint_ami has multiple @param documentation sections
> res/res_pjsip.c:3736: warning: The following parameter of ast_sip_format_endpoint_ami(struct ast_sip_endpoint *endpoint, struct ast_sip_ami *ami, int *count) is not documented:
> parameter 'ami'
> include/asterisk/res_pjsip.h:1122: warning: argument 'auth' of command @param is not found in the argument list of ast_sip_register_outbound_authenticator(struct ast_sip_outbound_authenticator *outbound_auth)
> res/res_pjsip.c:3426: warning: The following parameter of ast_sip_register_outbound_authenticator(struct ast_sip_outbound_authenticator *outbound_auth) is not documented:
> parameter 'outbound_auth'
> res/res_pjsip.c:4548: warning: documented empty return type of ast_sip_register_supplement
> include/asterisk/res_pjsip.h:2241: warning: argument 'timeout.' of command @param is not found in the argument list of ast_sip_send_out_of_dialog_request(pjsip_tx_data *tdata, struct ast_sip_endpoint *endpoint, int timeout, void *token, void(*callback)(void *token, pjsip_event *e))
> res/res_pjsip.c:5030: warning: The following parameter of ast_sip_send_out_of_dialog_request(pjsip_tx_data *tdata, struct ast_sip_endpoint *endpoint, int timeout, void *token, void(*callback)(void *token, pjsip_event *e)) is not documented:
> parameter 'timeout'
> include/asterisk/res_pjsip.h:2293: warning: argument 'endpoint' of command @param is not found in the argument list of ast_sip_send_response(pjsip_response_addr *res_addr, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint)
> res/res_pjsip.c:5444: warning: The following parameter of ast_sip_send_response(pjsip_response_addr *res_addr, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint) is not documented:
> parameter 'sip_endpoint'
> include/asterisk/res_pjsip.h:2310: warning: argument 'endpoint' of command @param is not found in the argument list of ast_sip_send_stateful_response(pjsip_rx_data *rdata, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint)
> res/res_pjsip.c:5457: warning: The following parameter of ast_sip_send_stateful_response(pjsip_rx_data *rdata, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint) is not documented:
> parameter 'sip_endpoint'
> include/asterisk/res_pjsip.h:583: warning: argument 'param' of command @param is not found in the argument list of ast_sip_call_codec_pref_test(__param, __codec_pref)
> include/asterisk/res_pjsip.h:583: warning: argument 'codec_pref' of command @param is not found in the argument list of ast_sip_call_codec_pref_test(__param, __codec_pref)
> include/asterisk/res_pjsip.h:591: warning: The following parameters of ast_sip_call_codec_pref_test(__param, __codec_pref) are not documented:
> parameter '__param'
> parameter '__codec_pref'
> include/asterisk/res_pjsip.h:2440: warning: The following parameter of ast_sip_add_body_multipart(pjsip_tx_data *tdata, const struct ast_sip_body *bodies[], int num_bodies) is not documented:
> parameter 'num_bodies'
> include/asterisk/res_pjsip.h:2445: warning: argument 'body' of command @param is not found in the argument list of ast_sip_append_body(pjsip_tx_data *tdata, const char *body_text)
> include/asterisk/res_pjsip.h:2453: warning: The following parameter of ast_sip_append_body(pjsip_tx_data *tdata, const char *body_text) is not documented:
> parameter 'body_text'
> include/asterisk/res_pjsip.h:970: warning: argument 'array' of command @param is not found in the argument list of ast_sip_auth_vector_destroy(struct ast_sip_auth_vector *vector)
> include/asterisk/res_pjsip.h:972: warning: The following parameter of ast_sip_auth_vector_destroy(struct ast_sip_auth_vector *vector) is not documented:
> parameter 'vector'
> include/asterisk/res_pjsip.h:2168: warning: argument 'out' of command @param is not found in the argument list of ast_sip_create_rdata(pjsip_rx_data *rdata, char *packet, const char *src_name, int src_port, char *transport_type, const char *local_name, int local_port)
> include/asterisk/res_pjsip.h:2146: warning: argument 'out' of command @param is not found in the argument list of ast_sip_create_rdata_with_contact(pjsip_rx_data *rdata, char *packet, const char *src_name, int src_port, char *transport_type, const char *local_name, int local_port, const char *contact_uri)
> include/asterisk/res_pjsip.h:2272: warning: argument 'tdata' of command @param is not found in the argument list of ast_sip_create_response(const pjsip_rx_data *rdata, int st_code, struct ast_sip_contact *contact, pjsip_tx_data **p_tdata)
> include/asterisk/res_pjsip.h:2287: warning: The following parameter of ast_sip_create_response(const pjsip_rx_data *rdata, int st_code, struct ast_sip_contact *contact, pjsip_tx_data **p_tdata) is not documented:
> parameter 'p_tdata'
> include/asterisk/res_pjsip.h:2848: warning: argument 'endpoint' from the argument list of ast_sip_format_endpoint_ami has multiple @param documentation sections
> include/asterisk/res_pjsip.h:2848: warning: The following parameter of ast_sip_format_endpoint_ami(struct ast_sip_endpoint *endpoint, struct ast_sip_ami *ami, int *count) is not documented:
> parameter 'ami'
> include/asterisk/res_pjsip.h:3151: warning: documented empty return type of ast_sip_get_default_from_user
> include/asterisk/res_pjsip.h:3138: warning: documented empty return type of ast_sip_get_default_realm
> include/asterisk/res_pjsip.h:1122: warning: argument 'auth' of command @param is not found in the argument list of ast_sip_register_outbound_authenticator(struct ast_sip_outbound_authenticator *outbound_auth)
> include/asterisk/res_pjsip.h:1129: warning: The following parameter of ast_sip_register_outbound_authenticator(struct ast_sip_outbound_authenticator *outbound_auth) is not documented:
> parameter 'outbound_auth'
> include/asterisk/res_pjsip.h:2998: warning: documented empty return type of ast_sip_register_supplement
> include/asterisk/res_pjsip.h:2241: warning: argument 'timeout.' of command @param is not found in the argument list of ast_sip_send_out_of_dialog_request(pjsip_tx_data *tdata, struct ast_sip_endpoint *endpoint, int timeout, void *token, void(*callback)(void *token, pjsip_event *e))
> include/asterisk/res_pjsip.h:2265: warning: The following parameter of ast_sip_send_out_of_dialog_request(pjsip_tx_data *tdata, struct ast_sip_endpoint *endpoint, int timeout, void *token, void(*callback)(void *token, pjsip_event *e)) is not documented:
> parameter 'timeout'
> include/asterisk/res_pjsip.h:2293: warning: argument 'endpoint' of command @param is not found in the argument list of ast_sip_send_response(pjsip_response_addr *res_addr, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint)
> include/asterisk/res_pjsip.h:2305: warning: The following parameter of ast_sip_send_response(pjsip_response_addr *res_addr, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint) is not documented:
> parameter 'sip_endpoint'
> include/asterisk/res_pjsip.h:2310: warning: argument 'endpoint' of command @param is not found in the argument list of ast_sip_send_stateful_response(pjsip_rx_data *rdata, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint)
> include/asterisk/res_pjsip.h:2323: warning: The following parameter of ast_sip_send_stateful_response(pjsip_rx_data *rdata, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint) is not documented:
> parameter 'sip_endpoint'
> include/asterisk/res_pjsip.h:2834: warning: argument 'str' of command @param is not found in the argument list of ast_sip_sorcery_object_to_ami(const void *obj, struct ast_str **buf)
> include/asterisk/res_pjsip.h:2838: warning: The following parameter of ast_sip_sorcery_object_to_ami(const void *obj, struct ast_str **buf) is not documented:
> parameter 'buf'
> include/asterisk/res_pjsip.h:3576: warning: documented empty return type of ast_sip_transport_monitor_unregister
> include/asterisk/res_pjsip.h:3594: warning: documented empty return type of ast_sip_transport_monitor_unregister_all
> include/asterisk/res_pjsip.h:3612: warning: documented empty return type of ast_sip_transport_state_register
> include/asterisk/res_pjsip.h:3622: warning: documented empty return type of ast_sip_transport_state_unregister
> include/asterisk/res_pjsip.h:2552: warning: argument 'auth_ids' of command @param is not found in the argument list of AST_VECTOR(ast_sip_auth_objects_vector, struct ast_sip_auth *)
> include/asterisk/res_pjsip.h:2552: warning: argument 'auth_objects' of command @param is not found in the argument list of AST_VECTOR(ast_sip_auth_objects_vector, struct ast_sip_auth *)
> include/asterisk/res_pjsip.h:2558: warning: Found unknown command '\WARNING'
> include/asterisk/res_pjsip.h:2562: warning: Found unknown command '\NOTE'
> res/res_pjsip_authenticator_digest.c:193: warning: argument 'A' of command @param is not found in the argument list of build_nonce(struct ast_str **nonce, const char *timestamp, const pjsip_rx_data *rdata, const char *realm)
> res/res_pjsip_authenticator_digest.c:206: warning: The following parameters of build_nonce(struct ast_str **nonce, const char *timestamp, const pjsip_rx_data *rdata, const char *realm) are not documented:
> parameter 'nonce'
> parameter 'timestamp'
> res/res_pjsip_caller_id.c:743: warning: argument 'The' of command @param is not found in the argument list of add_id_headers(const struct ast_sip_session *session, pjsip_tx_data *tdata, const struct ast_party_id *id)
> res/res_pjsip_caller_id.c:753: warning: The following parameter of add_id_headers(const struct ast_sip_session *session, pjsip_tx_data *tdata, const struct ast_party_id *id) is not documented:
> parameter 'id'
> res/res_pjsip_caller_id.c:560: warning: The following parameter of add_pai_header(const struct ast_sip_session *session, pjsip_tx_data *tdata, const struct ast_party_id *id) is not documented:
> parameter 'session'
> res/res_pjsip_caller_id.c:696: warning: The following parameter of add_rpid_header(const struct ast_sip_session *session, pjsip_tx_data *tdata, const struct ast_party_id *id) is not documented:
> parameter 'session'
> res/res_pjsip_caller_id.c:485: warning: The following parameter of create_new_id_hdr(const pj_str_t *hdr_name, pjsip_fromto_hdr *base, pjsip_tx_data *tdata, const struct ast_party_id *id) is not documented:
> parameter 'base'
> include/asterisk/res_pjsip_cli.h:105: warning: The following parameter of ast_sip_cli_print_sorcery_objectset(void *obj, void *arg, int flags) is not documented:
> parameter 'flags'
> include/asterisk/res_pjsip_cli.h:76: warning: argument 'name' of command @param is not found in the argument list of ast_sip_register_cli_formatter(struct ast_sip_cli_formatter_entry *formatter)
> include/asterisk/res_pjsip_cli.h:85: warning: argument 'name' of command @param is not found in the argument list of ast_sip_unregister_cli_formatter(struct ast_sip_cli_formatter_entry *formatter)
> include/asterisk/res_pjsip_cli.h:88: warning: The following parameter of ast_sip_unregister_cli_formatter(struct ast_sip_cli_formatter_entry *formatter) is not documented:
> parameter 'formatter'
> res/res_pjsip_history.c:775: warning: unable to resolve reference to 'vector_history' for \ref command
> res/res_pjsip_history.c:76: warning: unable to resolve reference to 'vector_history' for \ref command
> res/res_pjsip_history.c:107: warning: argument 'op' of command @param is not found in the argument list of AST_VECTOR(vector_history_t, struct pjsip_history_entry *)
> res/res_pjsip_history.c:107: warning: argument 'type' of command @param is not found in the argument list of AST_VECTOR(vector_history_t, struct pjsip_history_entry *)
> res/res_pjsip_history.c:107: warning: argument 'operand' of command @param is not found in the argument list of AST_VECTOR(vector_history_t, struct pjsip_history_entry *)
> res/res_pjsip_history.c:107: warning: argument 'op' of command @param is not found in the argument list of AST_VECTOR(vector_history_t, struct pjsip_history_entry *)
> res/res_pjsip_history.c:107: warning: argument 'type' of command @param is not found in the argument list of AST_VECTOR(vector_history_t, struct pjsip_history_entry *)
> res/res_pjsip_history.c:107: warning: argument 'op_left' of command @param is not found in the argument list of AST_VECTOR(vector_history_t, struct pjsip_history_entry *)
> res/res_pjsip_history.c:107: warning: argument 'op_right' of command @param is not found in the argument list of AST_VECTOR(vector_history_t, struct pjsip_history_entry *)
> res/res_pjsip_history.c:80: warning: return value '-1' of AST_VECTOR has multiple documentation sections
> res/res_pjsip_history.c:80: warning: return value '0' of AST_VECTOR has multiple documentation sections
> res/res_pjsip_history.c:80: warning: return value '1' of AST_VECTOR has multiple documentation sections
> res/res_pjsip_history.c:797: warning: Found unknown command '\params'
> res/res_pjsip_history.c:775: warning: unable to resolve reference to 'vector_history' for \ref command
> res/res_pjsip_history.c:545: warning: unexpected token in comment block while parsing the argument of command retval
> res/res_pjsip_history.c:76: warning: unable to resolve reference to 'vector_history' for \ref command
> res/res_pjsip_messaging.c:570: warning: Found unknown command '@domain'
> res/res_pjsip_messaging.c:574: warning: Found unknown command '@host'
> res/res_pjsip_messaging.c:576: warning: Found unknown command '@host'
> res/res_pjsip_messaging.c:578: warning: Found unknown command '@host'
> res/res_pjsip_messaging.c:580: warning: Found unknown command '@host'
> res/res_pjsip_messaging.c:584: warning: Found unknown command '@host'
> res/res_pjsip_messaging.c:586: warning: Found unknown command '@host'
> res/res_pjsip_messaging.c:588: warning: Found unknown command '@host'
> res/res_pjsip_messaging.c:592: warning: Found unknown command '@host'
> res/res_pjsip_messaging.c:595: warning: Found unknown command '@endpoint'
> res/res_pjsip_messaging.c:496: warning: Found unknown command '@host'
> res/res_pjsip_messaging.c:497: warning: Found unknown command '@host'
> res/res_pjsip_messaging.c:498: warning: Found unknown command '@host'
> res/res_pjsip_messaging.c:499: warning: Found unknown command '@host'
> res/res_pjsip_messaging.c:505: warning: The following parameters of handle_atsign(const char *to, char *destination, char **uri, char *slash, char *atsign, char *scheme) are not documented:
> parameter 'destination'
> parameter 'slash'
> parameter 'atsign'
> parameter 'scheme'
> res/res_pjsip_messaging.c:288: warning: The following parameter of handle_single_token(const char *to, char *destination, char **uri) is not documented:
> parameter 'destination'
> res/res_pjsip_messaging.c:346: warning: Found unknown command '@host'
> res/res_pjsip_messaging.c:348: warning: Found unknown command '@host'
> res/res_pjsip_messaging.c:350: warning: Found unknown command '@host'
> res/res_pjsip_messaging.c:352: warning: Found unknown command '@host'
> res/res_pjsip_messaging.c:358: warning: The following parameters of handle_slash(const char *to, char *destination, char **uri, char *slash, char *atsign, char *scheme) are not documented:
> parameter 'destination'
> parameter 'slash'
> parameter 'atsign'
> parameter 'scheme'
> res/res_pjsip_messaging.c:1203: warning: argument 'mdata' of command @param is not found in the argument list of msg_send(void *data)
> res/res_pjsip_messaging.c:1221: warning: The following parameter of msg_send(void *data) is not documented:
> parameter 'data'
> res/res_pjsip_notify.c:1075: warning: Found unknown command '\interanl'
> res/res_pjsip_notify.c:674: warning: Found unknown command '\detail'
> res/res_pjsip_outbound_authenticator_digest.c:121: warning: Found unknown command '\NOTE'
> res/res_pjsip_outbound_registration.c:2399: warning: documented empty return type of registration_loaded_observer
> res/res_pjsip_outbound_registration.c:939: warning: documented empty return type of registration_transport_shutdown_cb
> res/res_pjsip_path.c:106: warning: argument 'endpoint' of command @param is not found in the argument list of path_get_string(pj_pool_t *pool, struct ast_sip_contact *contact, pj_str_t *path_str)
> res/res_pjsip_path.c:106: warning: argument 'contact_uri' of command @param is not found in the argument list of path_get_string(pj_pool_t *pool, struct ast_sip_contact *contact, pj_str_t *path_str)
> res/res_pjsip_path.c:113: warning: The following parameters of path_get_string(pj_pool_t *pool, struct ast_sip_contact *contact, pj_str_t *path_str) are not documented:
> parameter 'pool'
> parameter 'contact'
> include/asterisk/res_pjsip_presence_xml.h:74: warning: The following parameter of ast_sip_presence_exten_state_to_str(int state, char **statestring, char **pidfstate, char **pidfnote, enum ast_sip_pidf_state *local_state, unsigned int notify_early_inuse_ringing) is not documented:
> parameter 'notify_early_inuse_ringing'
> include/asterisk/res_pjsip_presence_xml.h:118: warning: documented empty return type of ast_sip_presence_xml_find_node_attr
> res/res_pjsip/include/res_pjsip_private.h:192: warning: documented empty return type of ast_sip_destroy_global_headers
> res/res_pjsip/include/res_pjsip_private.h:184: warning: documented empty return type of ast_sip_initialize_global_headers
> res/res_pjsip/include/res_pjsip_private.h:385: warning: Found unknown command '\r'
> res/res_pjsip_publish_asterisk.c:168: warning: argument 'ast_event' of command @param is not found in the argument list of asterisk_publisher_devstate_cb(void *data, struct stasis_subscription *sub, struct stasis_message *msg)
> res/res_pjsip_publish_asterisk.c:173: warning: The following parameters of asterisk_publisher_devstate_cb(void *data, struct stasis_subscription *sub, struct stasis_message *msg) are not documented:
> parameter 'sub'
> parameter 'msg'
> res/res_pjsip_publish_asterisk.c:173: warning: documented empty return type of asterisk_publisher_devstate_cb
> res/res_pjsip_publish_asterisk.c:227: warning: argument 'ast_event' of command @param is not found in the argument list of asterisk_publisher_mwistate_cb(void *data, struct stasis_subscription *sub, struct stasis_message *msg)
> res/res_pjsip_publish_asterisk.c:232: warning: The following parameters of asterisk_publisher_mwistate_cb(void *data, struct stasis_subscription *sub, struct stasis_message *msg) are not documented:
> parameter 'sub'
> parameter 'msg'
> res/res_pjsip_publish_asterisk.c:232: warning: documented empty return type of asterisk_publisher_mwistate_cb
> res/res_pjsip_pubsub.c:2029: warning: The following parameter of add_rlmi_resource(pj_pool_t *pool, pj_xml_node *rlmi, const pjsip_generic_string_hdr *cid, const char *resource_name, const pjsip_sip_uri *resource_uri, pjsip_evsub_state state) is not documented:
> parameter 'rlmi'
> include/asterisk/res_pjsip_pubsub.h:346: warning: argument 'subscriber' of command @param is not found in the argument list of ast_sip_create_subscription(const struct ast_sip_subscription_handler *handler, struct ast_sip_endpoint *endpoint, const char *resource)
> res/res_pjsip_pubsub.c:1868: warning: The following parameter of ast_sip_create_subscription(const struct ast_sip_subscription_handler *handler, struct ast_sip_endpoint *endpoint, const char *resource) is not documented:
> parameter 'handler'
> include/asterisk/res_pjsip_pubsub.h:738: warning: argument 'generator' of command @param is not found in the argument list of ast_sip_pubsub_register_body_supplement(struct ast_sip_pubsub_body_supplement *supplement)
> res/res_pjsip_pubsub.c:3485: warning: The following parameter of ast_sip_pubsub_register_body_supplement(struct ast_sip_pubsub_body_supplement *supplement) is not documented:
> parameter 'supplement'
> include/asterisk/res_pjsip_pubsub.h:752: warning: argument 'generator' of command @param is not found in the argument list of ast_sip_pubsub_unregister_body_supplement(struct ast_sip_pubsub_body_supplement *supplement)
> res/res_pjsip_pubsub.c:3494: warning: The following parameter of ast_sip_pubsub_unregister_body_supplement(struct ast_sip_pubsub_body_supplement *supplement) is not documented:
> parameter 'supplement'
> res/res_pjsip_pubsub.c:1389: warning: documented empty return type of ast_sip_subscription_destroy
> res/res_pjsip_pubsub.c:1448: warning: argument 'out' of command @param is not found in the argument list of create_subscription_tree(const struct ast_sip_subscription_handler *handler, struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, const char *resource, struct ast_sip_pubsub_body_generator *generator, struct resource_tree *tree, pj_status_t *dlg_status, struct subscription_persistence *persistence)
> res/res_pjsip_pubsub.c:1465: warning: The following parameter of create_subscription_tree(const struct ast_sip_subscription_handler *handler, struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, const char *resource, struct ast_sip_pubsub_body_generator *generator, struct resource_tree *tree, pj_status_t *dlg_status, struct subscription_persistence *persistence) is not documented:
> parameter 'persistence'
> res/res_pjsip_pubsub.c:603: warning: documented empty return type of sub_tree_transport_cb
> res/res_pjsip_pubsub.c:924: warning: argument 'if' of command @param is not found in the argument list of tree_node_alloc(const char *resource, struct resources *visited, unsigned int full_state)
> res/res_pjsip_pubsub.c:934: warning: The following parameter of tree_node_alloc(const char *resource, struct resources *visited, unsigned int full_state) is not documented:
> parameter 'full_state'
> include/asterisk/res_pjsip_pubsub.h:346: warning: argument 'subscriber' of command @param is not found in the argument list of ast_sip_create_subscription(const struct ast_sip_subscription_handler *handler, struct ast_sip_endpoint *endpoint, const char *resource)
> include/asterisk/res_pjsip_pubsub.h:353: warning: The following parameter of ast_sip_create_subscription(const struct ast_sip_subscription_handler *handler, struct ast_sip_endpoint *endpoint, const char *resource) is not documented:
> parameter 'handler'
> include/asterisk/res_pjsip_pubsub.h:738: warning: argument 'generator' of command @param is not found in the argument list of ast_sip_pubsub_register_body_supplement(struct ast_sip_pubsub_body_supplement *supplement)
> include/asterisk/res_pjsip_pubsub.h:749: warning: The following parameter of ast_sip_pubsub_register_body_supplement(struct ast_sip_pubsub_body_supplement *supplement) is not documented:
> parameter 'supplement'
> include/asterisk/res_pjsip_pubsub.h:752: warning: argument 'generator' of command @param is not found in the argument list of ast_sip_pubsub_unregister_body_supplement(struct ast_sip_pubsub_body_supplement *supplement)
> include/asterisk/res_pjsip_pubsub.h:757: warning: The following parameter of ast_sip_pubsub_unregister_body_supplement(struct ast_sip_pubsub_body_supplement *supplement) is not documented:
> parameter 'supplement'
> include/asterisk/res_pjsip_pubsub.h:778: warning: documented empty return type of ast_sip_subscription_destroy
> res/res_pjsip_registrar.c:370: warning: documented empty return type of register_contact_transport_shutdown_cb
> res/res_pjsip_registrar.c:568: warning: The following parameters of remove_excess_contacts(struct ao2_container *contacts, struct ao2_container *response_contacts, unsigned int to_remove, unsigned int remove_existing) are not documented:
> parameter 'response_contacts'
> parameter 'remove_existing'
> res/res_pjsip_registrar.c:568: warning: documented empty return type of remove_excess_contacts
> res/res_pjsip_sdp_rtp.c:961: warning: argument 'endpoint_encryption' of command @param is not found in the argument list of check_endpoint_media_transport(struct ast_sip_endpoint *endpoint, const struct pjmedia_sdp_media *stream)
> res/res_pjsip_sdp_rtp.c:918: warning: The following parameter of check_endpoint_media_transport(struct ast_sip_endpoint *endpoint, const struct pjmedia_sdp_media *stream) is not documented:
> parameter 'endpoint'
> include/asterisk/res_pjsip_session.h:487: warning: argument 'inv_session' of command @param is not found in the argument list of ast_sip_session_alloc(struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, pjsip_inv_session *inv, pjsip_rx_data *rdata)
> res/res_pjsip_session.c:2990: warning: The following parameter of ast_sip_session_alloc(struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, pjsip_inv_session *inv, pjsip_rx_data *rdata) is not documented:
> parameter 'inv'
> res/res_pjsip_session.c:244: warning: The following parameter of ast_sip_session_media_stats_save(struct ast_sip_session *sip_session, struct ast_sip_session_media_state *media_state) is not documented:
> parameter 'sip_session'
> include/asterisk/res_pjsip_session.h:730: warning: argument 'generate_new_sdp' of command @param is not found in the argument list of ast_sip_session_regenerate_answer(struct ast_sip_session *session, ast_sip_session_sdp_creation_cb on_sdp_creation)
> res/res_pjsip_session.c:3155: warning: documented empty return type of ast_sip_session_suspend
> res/res_pjsip_session.c:3200: warning: documented empty return type of ast_sip_session_unsuspend
> res/res_pjsip_session.c:1751: warning: The following parameter of is_media_state_valid(const char *session_name, struct ast_sip_session_media_state *state) is not documented:
> parameter 'session_name'
> res/res_pjsip_session.c:1823: warning: argument 'run_validation' of command @param is not found in the argument list of resolve_refresh_media_states(const char *session_name, struct ast_sip_session_media_state *delayed_pending_state, struct ast_sip_session_media_state *delayed_active_state, struct ast_sip_session_media_state *current_active_state, int run_post_validation)
> res/res_pjsip_session.c:1835: warning: The following parameter of resolve_refresh_media_states(const char *session_name, struct ast_sip_session_media_state *delayed_pending_state, struct ast_sip_session_media_state *delayed_active_state, struct ast_sip_session_media_state *current_active_state, int run_post_validation) is not documented:
> parameter 'run_post_validation'
> res/res_pjsip_session.c:3588: warning: documented empty return type of sip_session_defer_termination_stop_timer
> include/asterisk/res_pjsip_session.h:487: warning: argument 'inv_session' of command @param is not found in the argument list of ast_sip_session_alloc(struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, pjsip_inv_session *inv, pjsip_rx_data *rdata)
> include/asterisk/res_pjsip_session.h:499: warning: The following parameter of ast_sip_session_alloc(struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, pjsip_inv_session *inv, pjsip_rx_data *rdata) is not documented:
> parameter 'inv'
> include/asterisk/res_pjsip_session.h:864: warning: The following parameter of ast_sip_session_media_stats_save(struct ast_sip_session *sip_session, struct ast_sip_session_media_state *media_state) is not documented:
> parameter 'sip_session'
> include/asterisk/res_pjsip_session.h:730: warning: argument 'generate_new_sdp' of command @param is not found in the argument list of ast_sip_session_regenerate_answer(struct ast_sip_session *session, ast_sip_session_sdp_creation_cb on_sdp_creation)
> include/asterisk/res_pjsip_session.h:512: warning: documented empty return type of ast_sip_session_suspend
> include/asterisk/res_pjsip_session.h:522: warning: documented empty return type of ast_sip_session_unsuspend
> include/asterisk/res_pjsip_session_caps.h:25: warning: argument 'codec_prefs' of command @param is not found in the argument list of ast_sip_create_joint_call_cap(const struct ast_format_cap *remote, struct ast_format_cap *local, enum ast_media_type media_type, struct ast_flags codec_pref)
> include/asterisk/res_pjsip_session_caps.h:40: warning: The following parameter of ast_sip_create_joint_call_cap(const struct ast_format_cap *remote, struct ast_format_cap *local, enum ast_media_type media_type, struct ast_flags codec_pref) is not documented:
> parameter 'codec_pref'
> res/res_pjsip_stir_shaken.c:69: warning: The following parameter of compare_caller_id(char *caller_id, const char *json_str) is not documented:
> parameter 'caller_id'
> include/asterisk/res_pjsip.h:2059: warning: The following parameters of ast_sip_sched_task_get_name(struct ast_sip_sched_task *schtd, char *name, size_t maxlen) are not documented:
> parameter 'name'
> parameter 'maxlen'
> include/asterisk/res_pjsip.h:1974: warning: argument 'last_end' from the argument list of ast_sip_sched_task_get_times2 has multiple @param documentation sections
> include/asterisk/res_pjsip.h:1974: warning: The following parameter of ast_sip_sched_task_get_times2(struct ast_sip_sched_task *schtd, struct timeval *when_queued, struct timeval *last_start, struct timeval *last_end, int *interval, int *time_left, struct timeval *next_start) is not documented:
> parameter 'next_start'
> include/asterisk/res_pjsip.h:2009: warning: argument 'last_end' from the argument list of ast_sip_sched_task_get_times_by_name2 has multiple @param documentation sections
> include/asterisk/res_pjsip.h:2009: warning: The following parameter of ast_sip_sched_task_get_times_by_name2(const char *name, struct timeval *when_queued, struct timeval *last_start, struct timeval *last_end, int *interval, int *time_left, struct timeval *next_start) is not documented:
> parameter 'next_start'
> include/asterisk/res_pjsip.h:1895: warning: found paragraph command (id: 'Serialization') outside of subsubsection context!
> include/asterisk/res_pjsip.h:1907: warning: unexpected token TK_EOF as the argument of ref
> include/asterisk/res_pjsip.h:1908: warning: unable to resolve reference to 'interval' for \ref command
> include/asterisk/res_pjsip.h:1909: warning: unable to resolve reference to 'interval' for \ref command
> include/asterisk/res_pjsip.h:1913: warning: unable to resolve reference to 'interval' for \ref command
> include/asterisk/res_pjsip.h:354: warning: Found unknown command '\detail'
> res/res_pjsip_outbound_registration.c:328: warning: Found unknown command '\bried'
> {code}
> Aside from typos which Doxygen is great to for unveiling, lessons to be learned from this one:
> * no plural, like \params and \details exist in Doxygen, except \returns
> * \detail without s does not exist et all either
> * not uppercase but lowercase like \note and \warning
> * \paragraph is for Latex parts and need proper section nesting, use \par instead
> * no reference to parameters, Doxygen simply does not allow it
> * no \c in return values because the first word after \retval is used verbatim anyway
> * \[out\] may not be playced after the parameter name but \param\[out\]
> * @ and \ must be escaped when used in text
> Furthermore, my Doxygen 1.9.1 has problems with {{AST_VECTOR}}. That are those warnings about ‘op_left’. I had to move it down just before the first #include statement. Not sure what is wrong there exactly. Finally, Doxygen is not able to resolve references to such vectors.
--
This message was sent by Atlassian JIRA
(v6.2#6252)
More information about the asterisk-bugs
mailing list