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

alias template can only be inline documented #736

Closed
wichtounet opened this issue Jan 3, 2016 · 4 comments
Closed

alias template can only be inline documented #736

wichtounet opened this issue Jan 3, 2016 · 4 comments
Assignees
Labels
Milestone

Comments

@wichtounet
Copy link
Contributor

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.

@guwirth
Copy link
Collaborator

guwirth commented Jan 3, 2016

@lcintrat
Copy link
Contributor

lcintrat commented Jan 3, 2016

Hi @wichtounet,

You are right, the second form should not count as an issue.

@wichtounet
Copy link
Contributor Author

Just tested and works fine :)

It saved me 2 days of technical debt :)

@lcintrat
Copy link
Contributor

lcintrat commented Jan 4, 2016

Good to know :)

Ty for the report 👍

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

No branches or pull requests

3 participants