[Doxygen-users] Comments inside the code.

[Angela S. <sta...@sa...>]

Hi all!

Do you know if it possible to write Doxygen comments inside C++ code?
I mean, writing something like this:

...
/*!
      The i-th element of \p scalar_prod will contain the scalar product

      of the k-th row of \p source and the i-th row of \p dest. If this
      product is 0 it means that the i-th generator saturates the k-th
      constraint.
*/
    vector<Integer> scalar_prod(dest_num_rows);
    /*!
      \p index_non_zero will indicate the first row of \p dest that does

      not saturate the k-th constraint.
    */
    size_t index_non_zero = dest_num_rows;
...


is the Doxygen directive \p recognized? And do the comments appear in
the documentation pages (and not only in the code)? I guess they don't,
but I hope there is a way to make they appear.

Thanks,
    Angela.