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

What is the expected behavior for seealso tag in a class doc comment #8725

Closed
yufeih opened this issue May 4, 2023 Discussed in #8724 · 0 comments · Fixed by #9491
Closed

What is the expected behavior for seealso tag in a class doc comment #8725

yufeih opened this issue May 4, 2023 Discussed in #8724 · 0 comments · Fixed by #9491
Labels
bug A bug to fix dotnet Generate .NET API reference docs

Comments

@yufeih
Copy link
Contributor

yufeih commented May 4, 2023

Discussed in #8724

Originally posted by pepone May 4, 2023
When I add a seealso tag to the class doc comment I see this rendered with the sealso section of each method in the class, and also in the seealso section of the class, for example:

/// <summary>A nice class</summary>
/// <seealso cref="MyOtherClass"/>
public class MyClass
{
    /// <summary>A nice operation similar to <see cref="MyOtherClass.MyOtherOperation(string, int)"/>.</summary>
    public void MyOperation() {}

    /// <summary>Another nice operation</summary>
    public void MoreOperations() {}
}
seealso-in-class

Is this the expected behavior? seems odd to repeat the same link over and over.

@yufeih yufeih added bug A bug to fix dotnet Generate .NET API reference docs labels May 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug A bug to fix dotnet Generate .NET API reference docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant