[asterisk-bugs] [JIRA] (ASTERISK-29733) progdocs: Avoid name with Doxygen \file

[Alexander Traud (JIRA)]

Alexander Traud created ASTERISK-29733:
------------------------------------------

             Summary: progdocs: Avoid name with Doxygen \file
                 Key: ASTERISK-29733
                 URL: https://issues.asterisk.org/jira/browse/ASTERISK-29733
             Project: Asterisk
          Issue Type: Bug
      Security Level: None
          Components: Documentation
    Affects Versions: 19.0.0, 18.8.0, 16.22.0
            Reporter: Alexander Traud
            Severity: Trivial
         Attachments: doxygen_file.patch

{code}
sudo apt install doxygen
make progdocs
{code}
gives three warnings in the file {{doxygen.log}}:
{code}
include/asterisk/res_prometheus.h:23: warning: the name 'res_prometheus' supplied as the argument in the \file statement is not an input file
res/prometheus/prometheus_internal.h:23: warning: the name 'prometheus_internal' supplied as the argument in the \file statement is not an input file
res/prometheus/prometheus_internal.h:27: warning: the name 'res_prometheus' supplied as the argument in the \file statement is not an input file
{code}because a *module* name (without file extension) but not the *file* name (.h or .c) was given. Because Doxygen uses the name of the current file automatically, the parameter can simply be dropped. The attached patch takes that approach.



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