[asterisk-bugs] [JIRA] (ASTERISK-29752) app: Fix for Doxygen

[Friendly Automation (JIRA)]

    [ https://issues.asterisk.org/jira/browse/ASTERISK-29752?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=257048#comment-257048 ] 

Friendly Automation commented on ASTERISK-29752:
------------------------------------------------

Change 17503 merged by Kevin Harwell:
app: Fix for Doxygen.

[https://gerrit.asterisk.org/c/asterisk/+/17503|https://gerrit.asterisk.org/c/asterisk/+/17503]

> app: Fix for Doxygen
> --------------------
>
>                 Key: ASTERISK-29752
>                 URL: https://issues.asterisk.org/jira/browse/ASTERISK-29752
>             Project: Asterisk
>          Issue Type: Bug
>      Security Level: None
>          Components: Applications/General, Documentation
>    Affects Versions: 16.22.0, 18.8.0, 19.0.0
>            Reporter: Alexander Traud
>            Assignee: 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}
> main/app.c:1478: warning: unable to resolve reference to 'AST_FORMAT_SLINEAR' for \ref command
> main/app.c:1478: warning: unable to resolve reference to 'AST_FORMAT_SLINEAR' for \ref command
> main/app.c:1521: warning: The following parameter of __ast_play_and_record(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, int *sound_duration, int beep, int silencethreshold, int maxsilence, const char *path, int prepend, const char *acceptdtmf, const char *canceldtmf, int skip_confirmation_sound, enum ast_record_if_exists if_exists) is not documented:
>   parameter 'if_exists'
> main/app.c:937: warning: documented empty return type of ast_dtmf_stream_external
> include/asterisk/app.h:677: warning: argument 'The' of command @param is not found in the argument list of ast_vm_greeter_unregister(const char *module_name)
> main/app.c:602: warning: The following parameter of ast_vm_greeter_unregister(const char *module_name) is not documented:
>   parameter 'module_name'
> main/app.c:602: warning: documented empty return type of ast_vm_greeter_unregister
> include/asterisk/app.h:774: warning: argument 'the' of command @param is not found in the argument list of ast_vm_mailbox_snapshot_create(const char *mailbox, const char *context, const char *folder, int descending, enum ast_vm_snapshot_sort_val sort_val, int combine_INBOX_and_OLD)
> include/asterisk/app.h:774: warning: argument 'the' of command @param is not found in the argument list of ast_vm_mailbox_snapshot_create(const char *mailbox, const char *context, const char *folder, int descending, enum ast_vm_snapshot_sort_val sort_val, int combine_INBOX_and_OLD)
> include/asterisk/app.h:774: warning: argument 'OPTIONAL.' of command @param is not found in the argument list of ast_vm_mailbox_snapshot_create(const char *mailbox, const char *context, const char *folder, int descending, enum ast_vm_snapshot_sort_val sort_val, int combine_INBOX_and_OLD)
> include/asterisk/app.h:774: warning: argument 'list' of command @param is not found in the argument list of ast_vm_mailbox_snapshot_create(const char *mailbox, const char *context, const char *folder, int descending, enum ast_vm_snapshot_sort_val sort_val, int combine_INBOX_and_OLD)
> include/asterisk/app.h:774: warning: argument 'When' of command @param is not found in the argument list of ast_vm_mailbox_snapshot_create(const char *mailbox, const char *context, const char *folder, int descending, enum ast_vm_snapshot_sort_val sort_val, int combine_INBOX_and_OLD)
> main/app.c:752: warning: The following parameter of ast_vm_mailbox_snapshot_create(const char *mailbox, const char *context, const char *folder, int descending, enum ast_vm_snapshot_sort_val sort_val, int combine_INBOX_and_OLD) is not documented:
>   parameter 'sort_val'
> include/asterisk/app.h:610: warning: argument 'The' of command @param is not found in the argument list of ast_vm_unregister(const char *module_name)
> main/app.c:491: warning: The following parameter of ast_vm_unregister(const char *module_name) is not documented:
>   parameter 'module_name'
> main/app.c:491: warning: documented empty return type of ast_vm_unregister
> main/app.c:1429: warning: unable to resolve reference to 'AST_FORMAT_SLINEAR' for \ref command
> main/app.c:1478: warning: unable to resolve reference to 'AST_FORMAT_SLINEAR' for \ref command
> include/asterisk/app.h:354: warning: Found unknown command '@context'
> include/asterisk/app.h:383: warning: Found unknown command '@context'
> include/asterisk/app.h:366: warning: Found unknown command '@context'
> include/asterisk/app.h:447: warning: Found unknown command '@context'
> include/asterisk/app.h:448: warning: Found unknown command '@context'
> include/asterisk/app.h:138: warning: argument 'c' from the argument list of ast_app_getdata has multiple @param documentation sections
> include/asterisk/app.h:138: warning: argument 'prompt' from the argument list of ast_app_getdata has multiple @param documentation sections
> include/asterisk/app.h:138: warning: argument 's' from the argument list of ast_app_getdata has multiple @param documentation sections
> include/asterisk/app.h:138: warning: argument 'maxlen' from the argument list of ast_app_getdata has multiple @param documentation sections
> include/asterisk/app.h:138: warning: argument 'timeout' from the argument list of ast_app_getdata has multiple @param documentation sections
> include/asterisk/app.h:155: warning: argument 'c' from the argument list of ast_app_getdata_terminator has multiple @param documentation sections
> include/asterisk/app.h:155: warning: argument 'prompt' from the argument list of ast_app_getdata_terminator has multiple @param documentation sections
> include/asterisk/app.h:155: warning: argument 's' from the argument list of ast_app_getdata_terminator has multiple @param documentation sections
> include/asterisk/app.h:155: warning: argument 'maxlen' from the argument list of ast_app_getdata_terminator has multiple @param documentation sections
> include/asterisk/app.h:155: warning: argument 'timeout' from the argument list of ast_app_getdata_terminator has multiple @param documentation sections
> include/asterisk/app.h:155: warning: argument 'terminator' from the argument list of ast_app_getdata_terminator has multiple @param documentation sections
> include/asterisk/app.h:986: warning: documented empty return type of ast_dtmf_stream_external
> include/asterisk/app.h:677: warning: argument 'The' of command @param is not found in the argument list of ast_vm_greeter_unregister(const char *module_name)
> include/asterisk/app.h:684: warning: The following parameter of ast_vm_greeter_unregister(const char *module_name) is not documented:
>   parameter 'module_name'
> include/asterisk/app.h:684: warning: documented empty return type of ast_vm_greeter_unregister
> include/asterisk/app.h:774: warning: argument 'the' of command @param is not found in the argument list of ast_vm_mailbox_snapshot_create(const char *mailbox, const char *context, const char *folder, int descending, enum ast_vm_snapshot_sort_val sort_val, int combine_INBOX_and_OLD)
> include/asterisk/app.h:774: warning: argument 'the' of command @param is not found in the argument list of ast_vm_mailbox_snapshot_create(const char *mailbox, const char *context, const char *folder, int descending, enum ast_vm_snapshot_sort_val sort_val, int combine_INBOX_and_OLD)
> include/asterisk/app.h:774: warning: argument 'OPTIONAL.' of command @param is not found in the argument list of ast_vm_mailbox_snapshot_create(const char *mailbox, const char *context, const char *folder, int descending, enum ast_vm_snapshot_sort_val sort_val, int combine_INBOX_and_OLD)
> include/asterisk/app.h:774: warning: argument 'list' of command @param is not found in the argument list of ast_vm_mailbox_snapshot_create(const char *mailbox, const char *context, const char *folder, int descending, enum ast_vm_snapshot_sort_val sort_val, int combine_INBOX_and_OLD)
> include/asterisk/app.h:774: warning: argument 'When' of command @param is not found in the argument list of ast_vm_mailbox_snapshot_create(const char *mailbox, const char *context, const char *folder, int descending, enum ast_vm_snapshot_sort_val sort_val, int combine_INBOX_and_OLD)
> include/asterisk/app.h:785: warning: The following parameter of ast_vm_mailbox_snapshot_create(const char *mailbox, const char *context, const char *folder, int descending, enum ast_vm_snapshot_sort_val sort_val, int combine_INBOX_and_OLD) is not documented:
>   parameter 'sort_val'
> include/asterisk/app.h:610: warning: argument 'The' of command @param is not found in the argument list of ast_vm_unregister(const char *module_name)
> include/asterisk/app.h:614: warning: The following parameter of ast_vm_unregister(const char *module_name) is not documented:
>   parameter 'module_name'
> include/asterisk/app.h:614: warning: documented empty return type of ast_vm_unregister
> {code}



--
This message was sent by Atlassian JIRA
(v6.2#6252)