doxygen C++ inline template documentation

Question

Is there some way to document template parameters like this:

template<
    int N, ///< description
    typename T ///< description
>

rather than listing each parameter with tparam?

please note that function arguments can be documented like this in current doxygen:

void function(int a /**< description */);

if there is not one, how hard would be to implement it? if you are familiar with doxygen internals, can you point me in the direction where to implement it.

thank you

arturh · Accepted Answer · 2010-05-31 10:48:32Z

5

There is no way to document your template parameters like you described.

I would say it is not a good idea, because then you would document your template parameters differently from your usual parameters, and why would you want that?

Usually it looks like this:

/*! \p transpose : transpose a matrix
 *
 * \param A input matrix
 * \param At output matrix (transpose of A)
 *
 * \tparam MatrixType1 matrix
 * \tparam MatrixType2 matrix
 */

template <typename MatrixType1, typename MatrixType2>
void transpose(const MatrixType1& A, MatrixType2& At);

and you want it to look like this?!

/*! \p transpose : transpose a matrix
 *
 * \param A input matrix
 * \param At output matrix (transpose of A)
 *
 */

template <
  typename MatrixType1, ///< matrix
  typename MatrixType2  ///< matrix
>
void transpose(const MatrixType1& A, MatrixType2& At);

Why?

answered May 31, 2010 at 10:48

arturh

6,1265 gold badges42 silver badges49 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Pieter Over a year ago

He could place each usual parameter on a new line as well.

Anycorn Over a year ago

yes, I also wanted to place parameters like that. I just find it somewhat easier to read (in source), since parameter is documented right after the declaration

HelloGoodbye Over a year ago

By documenting the parameters where they are defined in the code, the risk of forgetting to document a new parameter when it is added, or forgetting to remove the documentation of a parameter when it is removed, decreases significantly.

Collectives™ on Stack Overflow

doxygen C++ inline template documentation

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related