You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Are there currently any plans to address this issue? I'm encountering this currently. If there are currently no plans to address this issue, would the maintainers be open to a PR fixing this? I wouldn't be opposed to doing it, but have never worked on Doxygen before, so it would be nice if someone could point me in the right direction.
By the way-- for other C# devs encountering this issue, you can mitigate this by using the System.ValueTuple<> syntax instead of the parenthesis syntax. For instance:
I also ran into this with a method and can confirm that by changing the return type to a single value doxygen generated the doc. But with the tuple it says it's not documented.
Simplified example:
/// <summary>
/// Returns both GUID and local File ID.
/// </summary>
/// <param name="obj"></param>
/// <returns></returns>
public static (GUID, Int64) GetGuidAndFileId(Object obj)
{
return (new GUID(), 0L);
}
Changing return value to ValueTuple works as per suggestion by @computablee :
public static ValueTuple<GUID, Int64> GetGuidAndFileId(Object obj)
But the output of course also lists ValueTuple<> as return type:
albert-github
changed the title
C# tuple propertyies are seen as not documented
C# tuple properties are seen as not documented
Nov 24, 2023
Describe the bug
when using tupple in C# like
Doxygen see the defition as uncommented (but it was):
Main.cs(10): warning: Member Tupple (property) of class Test is not documented.
Moreover, the generate documentation is wrong (it does not mention the Tupple property, but see it as a data menber called int (??):
Sample Files
testdoc.zip
Version
1.9.1
The text was updated successfully, but these errors were encountered: