Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

C# tuple properties are seen as not documented #9618

Open
Labouh opened this issue Sep 28, 2022 · 2 comments
Open

C# tuple properties are seen as not documented #9618

Labouh opened this issue Sep 28, 2022 · 2 comments
Labels

Comments

@Labouh
Copy link

Labouh commented Sep 28, 2022

Describe the bug
when using tupple in C# like

/// <summary>
/// Tuple seem as not documented
/// </summary>
public (int, int) Tupple { get; }

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 (??):
image

Sample Files
testdoc.zip

Version
1.9.1

@Labouh Labouh changed the title C# tupple method are seen as not documented C# tupple propertyies are seen as not documented Sep 28, 2022
@Labouh Labouh changed the title C# tupple propertyies are seen as not documented C# tuple propertyies are seen as not documented Sep 28, 2022
@computablee
Copy link

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:

private ValueTuple<int, int> tuple;

public void SetTuple((int, int) tuple)
{
    this.tuple = tuple;
}

@CodeSmile-0000011110110111
Copy link

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:
image

@albert-github albert-github changed the title C# tuple propertyies are seen as not documented C# tuple properties are seen as not documented Nov 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants