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

Inconsistency in generics hyperlink #917

Closed
joshuaavalon opened this issue Nov 22, 2016 · 3 comments
Closed

Inconsistency in generics hyperlink #917

joshuaavalon opened this issue Nov 22, 2016 · 3 comments

Comments

@joshuaavalon
Copy link

joshuaavalon commented Nov 22, 2016

Platform: Windows
Version: 2.8

Minimal repro steps

/// <summary>
///     Using Breadth First Search to find path with given <see cref="IGraph{T}" />
///     from <paramref name="start" /> to <paramref cref="goal" />.
/// </summary>
/// <typeparam name="T">Graph node.</typeparam>
/// <param name="graph">Graph</param>
/// <param name="start">Start of the path.</param>
/// <param name="goal">End of the path.</param>
/// <returns>
///     Path from <paramref name="start" /> to <paramref cref="goal" />.
///     Empty if no path can be found.
/// </returns>
public static IEnumerable<T> BreadthFirstSearch<T>(IGraph<T> graph, T start, T goal)
{
	...
}

Expected result

IGraph<T> is hyperlinked.

Actual result

In summary, IGraph<T> is hyperlinked. However, in parameter, seealso, only IGraph is hyperlinked. <T> is shown as plain text.

This may related to #896 and #900.

@joshuaavalon
Copy link
Author

Here is a reference image.
sc

@vwxyzh
Copy link
Contributor

vwxyzh commented Nov 23, 2016

@joshuaavalon this behavior is as designed.

  1. Why IGragh in parameter is plan text?

    public static IEnumerable<T> BreadthFirstSearch<T>(IGraph<T> graph, T start, T goal)

    If the parameter is IGraph<string>, we should create two link, IGraph is link to class IGraph<TNode>, string is link to string class.
    In this method, T is define by method, i.e. BreadthFirstSearch<T>.
    We can not create a link to this method, and actually we are just here, so we write it as plan text.

  2. Why <see cref="IGraph{T}" /> in summary is one hyper link?

    After Roslyn compile, we will get <see cref="YourNamespace.IGraph`1">, so we will show the name of IGraph, i.e. IGraph<TNode>.

@joshuaavalon
Copy link
Author

@vwxyzh Thank you for your explanation. I will close this issue then.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants