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

Convert top level <see> to <seealso> #75

Open
drewnoakes opened this issue Nov 20, 2018 · 3 comments
Open

Convert top level <see> to <seealso> #75

drewnoakes opened this issue Nov 20, 2018 · 3 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@drewnoakes
Copy link

/// <see cref="Foo" />
public bool Bar();

This is invalid.

The author probably intended:

/// <seealso cref="Foo" />
public bool Bar();
@sharwell sharwell added the enhancement New feature or request label Nov 20, 2018
@sharwell
Copy link
Member

💡 This can be added to the existing DOC204 (Use inline elements correctly) rule.

@sharwell sharwell added the help wanted Extra attention is needed label Nov 20, 2018
@YoshiRulz
Copy link

Could it also flag the inverse? For example:

/// <summary>Initialises an <seealso cref="IController"/> and stores it in <seealso cref="CurrentController"/></summary>
void InitController();

@sharwell
Copy link
Member

@YoshiRulz Yes, but that would be added to the existing DOC202 (Use section elements correctly) rule.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants