We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
Hi,
I just discovered that alias templates can only be documented with inline comment (after member documentation).
This does not show an issue:
template <typename T> using intrinsic_type = typename intrinsic_traits<T>::intrinsic_type; ///< DOCUMENTATION
But this is shown as undocumented API:
/*! * \brief DOCUMENTATION */ template <typename T> using intrinsic_type = typename intrinsic_traits<T>::intrinsic_type;
I think that the second should be supported since it is the only form that allows to document the template parameters.
The text was updated successfully, but these errors were encountered:
An example is on the rule page in SQ: https://github.com/SonarOpenCommunity/sonar-cxx/blob/master/cxx-checks/src/main/resources/org/sonar/l10n/c%2B%2B/rules/cxx/UndocumentedApi.html
Sorry, something went wrong.
Hi @wichtounet,
You are right, the second form should not count as an issue.
Add documentation node searching for template alias declaration
7a5e47a
Fix issue SonarOpenCommunity#736
Just tested and works fine :)
It saved me 2 days of technical debt :)
Good to know :)
Ty for the report 👍
lcintrat
No branches or pull requests
Hi,
I just discovered that alias templates can only be documented with inline comment (after member documentation).
This does not show an issue:
But this is shown as undocumented API:
I think that the second should be supported since it is the only form that allows to document the template parameters.
The text was updated successfully, but these errors were encountered: