Summary:	ASTERISK-29740: apps: Fix for Doxygen
Reporter:	Alexander Traud (traud)	Labels:
Date Opened:	2021-11-15 07:22:51.000-0600	Date Closed:	2021-11-18 10:37:24.000-0600
Priority:	Trivial	Regression?
Status:	Closed/Complete	Components:	Applications/app_agent_pool Applications/app_alarmreceiver Applications/app_bridgewait Applications/app_chanspy Applications/app_confbridge Applications/app_dial Applications/app_jack Applications/app_meetme Applications/app_minivm Applications/app_mixmonitor Applications/app_page Applications/app_queue Applications/app_voicemail Documentation
Versions:	16.22.0 18.8.0 19.0.0	Frequency of Occurrence
Related Issues:
Environment:		Attachments:
Description:	If all {{WARN_}} are enabled in the file {{doc/asterisk-ng-doxygen.in}}, the following appears in the file {{doxygen.log}}: {code} apps/app_agent_pool.c:27: warning: unable to resolve reference to 'Config_agent' for \ref command apps/app_agent_pool.c:1028: warning: documented empty return type of agent_connect_caller apps/app_agent_pool.c:750: warning: documented empty return type of agent_devstate_changed apps/app_agent_pool.c:2034: warning: documented empty return type of agent_login_channel_config apps/app_agent_pool.c:1475: warning: documented empty return type of agent_logout apps/app_agent_pool.c:1514: warning: documented empty return type of agent_run apps/app_agent_pool.c:1382: warning: documented empty return type of bridge_agent_hold_dissolving apps/app_agent_pool.c:1363: warning: documented empty return type of bridge_agent_hold_pull apps/app_agent_pool.c:1011: warning: documented empty return type of clear_agent_status apps/app_alarmreceiver.c:208: warning: documented empty return type of database_increment apps/app_bridgewait.c:395: warning: argument 'chan' of command @param is not found in the argument list of validate_role(const char *role) apps/app_bridgewait.c:395: warning: argument 'data' of command @param is not found in the argument list of validate_role(const char *role) apps/app_bridgewait.c:378: warning: The following parameter of validate_role(const char *role) is not documented:  parameter 'role' apps/app_chanspy.c:561: warning: Found unknown command '\start' apps/app_chanspy.c:565: warning: The following parameter of publish_chanspy_message(struct ast_channel *spyer, struct ast_channel *spyee, int start) is not documented:  parameter 'start' apps/confbridge/include/confbridge.h:701: warning: argument 'confbridge_name' of command @param is not found in the argument list of conf_find_bridge(const char *conference_name) apps/app_confbridge.c:787: warning: The following parameter of conf_find_bridge(const char *conference_name) is not documented:  parameter 'conference_name' apps/app_confbridge.c:1457: warning: documented empty return type of conf_handle_first_join apps/app_confbridge.c:803: warning: return value 'conference' of conf_is_recording has multiple documentation sections apps/app_confbridge.c:1360: warning: documented empty return type of conf_moh_start apps/app_confbridge.c:1333: warning: documented empty return type of conf_moh_stop apps/app_confbridge.c:1412: warning: documented empty return type of conf_moh_suspend apps/app_confbridge.c:1395: warning: documented empty return type of conf_moh_unsuspend apps/app_confbridge.c:1275: warning: documented empty return type of conf_update_user_mute apps/app_confbridge.c:1173: warning: documented empty return type of destroy_conference_bridge apps/app_confbridge.c:4361: warning: documented empty return type of unregister_channel_tech apps/app_dial.c:2216: warning: documented empty return type of setup_peer_after_bridge_goto apps/app_dial.c:1173: warning: documented empty return type of update_connected_line_from_peer apps/app_jack.c:621: warning: documented empty return type of handle_jack_audio apps/app_meetme.c:3155: warning: The following parameters of meetme_menu(enum menu_modes *menu_mode, int *dtmf, struct ast_conference *conf, struct ast_flags64 *confflags, struct ast_channel *chan, struct ast_conf_user *user, char *recordingtmp, int recordingtmp_size, struct ast_format_cap *cap_slin) are not documented:  parameter 'recordingtmp_size'  parameter 'cap_slin' apps/app_meetme.c:2968: warning: The following parameters of meetme_menu_admin_extended(enum menu_modes *menu_mode, int *dtmf, struct ast_conference *conf, struct ast_flags64 *confflags, struct ast_channel *chan, struct ast_conf_user *user, char *recordingtmp, int recordingtmp_size, struct ast_format_cap *cap_slin) are not documented:  parameter 'recordingtmp_size'  parameter 'cap_slin' apps/app_meetme.c:1335: warning: argument 'meetme_confere' of command @param is not found in the argument list of meetme_stasis_generate_msg(struct ast_conference *meetme_conference, struct ast_channel *chan, struct ast_conf_user *user, struct stasis_message_type *message_type, struct ast_json *extras) apps/app_meetme.c:1345: warning: The following parameter of meetme_stasis_generate_msg(struct ast_conference *meetme_conference, struct ast_channel *chan, struct ast_conf_user *user, struct stasis_message_type *message_type, struct ast_json *extras) is not documented:  parameter 'meetme_conference' apps/app_mixmonitor.c:635: warning: The following parameter of copy_to_voicemail(struct mixmonitor *mixmonitor, const char *ext, const char *filename) is not documented:  parameter 'filename' apps/app_page.c:180: warning: documented empty return type of setup_profile_bridge apps/app_page.c:222: warning: documented empty return type of setup_profile_caller apps/app_page.c:198: warning: documented empty return type of setup_profile_paged apps/app_queue.c:1664: warning: Unsupported xml/html tag <limit> found apps/app_queue.c:4285: warning: documented empty return type of callattempt_free apps/app_queue.c:6255: warning: argument 'topic' of command @param is not found in the argument list of handle_attended_transfer(void *userdata, struct stasis_subscription *sub, struct stasis_message *msg) apps/app_queue.c:6195: warning: argument 'topic' of command @param is not found in the argument list of handle_blind_transfer(void *userdata, struct stasis_subscription *sub, struct stasis_message *msg) apps/app_queue.c:6158: warning: argument 'topic' of command @param is not found in the argument list of handle_bridge_enter(void *userdata, struct stasis_subscription *sub, struct stasis_message *msg) apps/app_queue.c:6443: warning: argument 'topic' of command @param is not found in the argument list of handle_hangup(void *userdata, struct stasis_subscription *sub, struct stasis_message *msg) apps/app_queue.c:6327: warning: argument 'topic' of command @param is not found in the argument list of handle_local_optimization_begin(void *userdata, struct stasis_subscription *sub, struct stasis_message *msg) apps/app_queue.c:6377: warning: argument 'topic' of command @param is not found in the argument list of handle_local_optimization_end(void *userdata, struct stasis_subscription *sub, struct stasis_message *msg) apps/app_queue.c:3427: warning: argument 'member' of command @param is not found in the argument list of member_remove_from_queue(struct call_queue *queue, struct member *mem) apps/app_queue.c:3433: warning: The following parameter of member_remove_from_queue(struct call_queue *queue, struct member *mem) is not documented:  parameter 'mem' apps/app_queue.c:1897: warning: The following parameter of queue_delme_members_decrement_followers(void *obj, void *arg, int flag) is not documented:  parameter 'flag' apps/app_queue.c:1879: warning: The following parameter of queue_member_decrement_followers(void *obj, void *arg, int flag) is not documented:  parameter 'flag' apps/app_queue.c:2244: warning: documented empty return type of queue_publish_member_blob apps/app_queue.c:9448: warning: documented empty return type of reload_single_queue apps/app_queue.c:7728: warning: argument 'penalty' of command @param is not found in the argument list of set_member_value(const char *queuename, const char *interface, int property, int value) apps/app_queue.c:7735: warning: The following parameter of set_member_value(const char *queuename, const char *interface, int property, int value) is not documented:  parameter 'value' apps/app_queue.c:7544: warning: documented empty return type of set_queue_member_pause apps/app_queue.c:7683: warning: documented empty return type of set_queue_member_ringinuse apps/app_queue.c:6657: warning: documented empty return type of setup_peer_after_bridge_goto apps/app_queue.c:4963: warning: documented empty return type of update_connected_line_from_peer apps/app_voicemail.c:29: warning: unable to resolve reference to 'Config_vm' for \ref command apps/app_voicemail.c:6154: warning: Found unknown command '@context' apps/app_voicemail.c:1093: warning: Found unknown command '@context' apps/confbridge/conf_state.c:58: warning: documented empty return type of conf_mute_moh_inactive_waitmarked apps/confbridge/include/confbridge.h:701: warning: argument 'confbridge_name' of command @param is not found in the argument list of conf_find_bridge(const char *conference_name) apps/confbridge/include/confbridge.h:709: warning: The following parameter of conf_find_bridge(const char *conference_name) is not documented:  parameter 'conference_name' apps/confbridge/include/confbridge.h:493: warning: documented empty return type of conf_handle_first_join apps/confbridge/include/confbridge.h:481: warning: documented empty return type of conf_moh_start apps/confbridge/include/confbridge.h:472: warning: documented empty return type of conf_moh_stop apps/confbridge/include/confbridge.h:463: warning: documented empty return type of conf_update_user_mute apps/app_minivm.c:81: warning: unable to resolve reference to 'Config_minivm' for \ref command apps/app_minivm.c:86: warning: unable to resolve reference to 'descrip_minivm_accmess' for \ref command apps/app_minivm.c:87: warning: unable to resolve reference to 'descrip_minivm_greet' for \ref command apps/app_minivm.c:88: warning: unable to resolve reference to 'descrip_minivm_record' for \ref command apps/app_minivm.c:89: warning: unable to resolve reference to 'descrip_minivm_delete' for \ref command apps/app_minivm.c:90: warning: unable to resolve reference to 'descrip_minivm_notify' for \ref command {code}
Comments:	By: Asterisk Team (asteriskteam) 2021-11-15 07:22:53.456-0600 Thanks for creating a report! The issue has entered the triage process. That means the issue will wait in this status until a Bug Marshal has an opportunity to review the issue. Once the issue has been reviewed you will receive comments regarding the next steps towards resolution. Please note that log messages and other files should not be sent to the Sangoma Asterisk Team unless explicitly asked for. All files should be placed on this issue in a sanitized fashion as needed. A good first step is for you to review the [Asterisk Issue Guidelines|https://wiki.asterisk.org/wiki/display/AST/Asterisk+Issue+Guidelines] if you haven't already. The guidelines detail what is expected from an Asterisk issue report. Then, if you are submitting a patch, please review the [Patch Contribution Process|https://wiki.asterisk.org/wiki/display/AST/Patch+Contribution+Process]. Please note that once your issue enters an open state it has been accepted. As Asterisk is an open source project there is no guarantee or timeframe on when your issue will be looked into. If you need expedient resolution you will need to find and pay a suitable developer. Asking for an update on your issue will not yield any progress on it and will not result in a response. All updates are posted to the issue when they occur. Please note that by submitting data, code, or documentation to Sangoma through JIRA, you accept the Terms of Use present at [https://www.asterisk.org/terms-of-use/|https://www.asterisk.org/terms-of-use/]. By: Friendly Automation (friendly-automation) 2021-11-18 10:37:26.099-0600 Change 17383 merged by George Joseph: apps: Fix for Doxygen. [https://gerrit.asterisk.org/c/asterisk/+/17383|https://gerrit.asterisk.org/c/asterisk/+/17383] By: Friendly Automation (friendly-automation) 2021-11-18 10:37:45.201-0600 Change 17381 merged by George Joseph: apps: Fix for Doxygen. [https://gerrit.asterisk.org/c/asterisk/+/17381|https://gerrit.asterisk.org/c/asterisk/+/17381] By: Friendly Automation (friendly-automation) 2021-11-18 10:37:59.686-0600 Change 17363 merged by George Joseph: apps: Fix for Doxygen. [https://gerrit.asterisk.org/c/asterisk/+/17363|https://gerrit.asterisk.org/c/asterisk/+/17363] By: Friendly Automation (friendly-automation) 2021-11-18 10:38:19.152-0600 Change 17382 merged by George Joseph: apps: Fix for Doxygen. [https://gerrit.asterisk.org/c/asterisk/+/17382|https://gerrit.asterisk.org/c/asterisk/+/17382]