Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incorrect docstrings #803

Open
artiomn opened this issue Jul 29, 2024 · 1 comment
Open

Incorrect docstrings #803

artiomn opened this issue Jul 29, 2024 · 1 comment

Comments

@artiomn
Copy link
Contributor

artiomn commented Jul 29, 2024

/vsts/agent/_work/2/s/third-party/pcm/src/cpucounters.h:483:10: error: duplicated command '\brief' [-Werror,-Wdocumentation]
    //! \brief metrics metric set (see the ServerUncoreMemoryMetrics enum)
        ~^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/vsts/agent/_work/2/s/third-party/pcm/src/cpucounters.h:480:10: note: previous command '\brief' here
    //! \brief Program memory counters (disables programming performance counters)
        ~^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/vsts/agent/_work/2/s/third-party/pcm/src/cpucounters.h:1183:14: error: '\returns' command used in a comment that is attached to a function returning void [-Werror,-Wdocumentation]
    *       \returns nothing
            ~^~~~~~~~~~~~~~~
/vsts/agent/_work/2/s/third-party/pcm/src/cpucounters.h:1191:14: error: '\returns' command used in a comment that is attached to a function returning void [-Werror,-Wdocumentation]
     *      \returns nothing
            ~^~~~~~~~~~~~~~~
/vsts/agent/_work/2/s/third-party/pcm/src/cpucounters.h:1766:10: error: '\return' command used in a comment that is attached to a function returning void [-Werror,-Wdocumentation]
        \return acceltype
        ~^~~~~~~~~~~~~~~~
/vsts/agent/_work/2/s/third-party/pcm/src/cpucounters.h:1776:10: error: '\return' command used in a comment that is attached to a function returning void [-Werror,-Wdocumentation]
        \return number of counters
        ~^~~~~~~~~~~~~~~~~~~~~~~~~
In file included from /vsts/agent/_work/2/s/third-party/pcm/src/cpucounters.h/vsts/agent/_work/2/s/knp/devices-library/impl/cpu.cpp:13:
/vsts/agent/_work/2/s/third-party/pcm/src/cpucounters.h:483:10: error: duplicated command '\brief' [-Werror,-Wdocumentation]

Probably CLang build with -Werror,-Wdocumentation will show this problem?

@rdementi
Copy link
Contributor

rdementi commented Aug 8, 2024

yes..

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants