DotNetAnalyzers / DocumentationAnalyzers

Analyzers for XML documentation
MIT License
35 stars 6 forks source link

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

Open drewnoakes opened 5 years ago

drewnoakes commented 5 years ago
/// <see cref="Foo" />
public bool Bar();

This is invalid.

The author probably intended:

/// <seealso cref="Foo" />
public bool Bar();
sharwell commented 5 years ago

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

YoshiRulz commented 3 years ago

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 commented 3 years ago

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