What is the correct way to reference template parameters in Doxygen?

Next question:

What is the correct way to reference a parameter in Doxygen?

So, for the parameters we use @param

@param my_param the quick brown fox takes this parameter over the lazy dog

and then we can access it with @p:

@param my_other_param this is completely different from @p my_param , you know!

Now, for the template options, I would replace @paramwith @tparam. What should be replaced @p?

+4
source share
2 answers

@pnot really "referring" to the parameter; it just erases the next word in the typewriter font. Usually you use this to set parameters, but @pit does nothing special except the typewriter font for the next word.

, @p , . @a. - . , , .

+4

, @ref. . Doxygen @ref.

-1

Source: https://habr.com/ru/post/1649293/


All Articles