1

I am using Doxygen 1.8.17 to document a C# project and I am trying to document this:

/// <summary>
/// returns the LU factorization of a general m-by-n matrix A as: P*A = L*U. 
/// </summary>
/// <param name="matrixA">a matrix m-by-n</param>
public static (double[,] L, double[,] U, double[,] P) LUDecomposition(double[,] matrixA)
{
  ...
  return (L, U, P);
}

Return type of the method is a ValueTuple. Doxygen process it as a static Public Attributes of the class, not as a Member Function and only shows L as return value:

enter image description here

Is there an option to make Doxygen able to deal with ValueTuple ? Does anyone has a workaround ? I would like avoid to define a special class for this output.

Thanks in advance for your help.

Guix

user2092113
  • 103
  • 1
  • 5
  • 1
    I think this is not (yet) supported by doxygen, see also C#: Methods returning a tuple are documented with a crippled signature (https://github.com/doxygen/doxygen/issues/7633). – albert Mar 26 '20 at 10:59
  • Thanks for the information. I did not see this GitHub issue ! – user2092113 Mar 26 '20 at 13:29

0 Answers0