intel / intel/pcm

Incorrect docstrings

Open
#803 1 comment 0 reactions 0 assignees View on GitHub
enhancement help wanted
Dominant language
C++
Stars
3.3k
Forks
528
Avg merge
1h 40m
Merged PRs (30d)
2

Description

```
/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?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.