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

Document template parameters in doxygen #185

Open
ischoegl opened this issue Aug 16, 2023 · 0 comments
Open

Document template parameters in doxygen #185

ischoegl opened this issue Aug 16, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation feature-request New feature request

Comments

@ischoegl
Copy link
Member

ischoegl commented Aug 16, 2023

Abstract

Doxygen has a directive to document template parameters, - @tparam, - see here, which would be useful to document.

Motivation

Describe the need for the proposed change:

  • What problem is it trying to solve? ... improve documentation
  • Who is affected by the change? ... developers who use C++
  • Why is this a good solution? ... it's worth documenting

Possible Solutions

add @tparam where applicable.

@ischoegl ischoegl added documentation Improvements or additions to documentation feature-request New feature request labels Aug 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature-request New feature request
Projects
None yet
Development

No branches or pull requests

1 participant