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

Feature Request: Add way to link to interfaces from doc #1223

Closed
ThadHouse opened this Issue Jan 22, 2017 · 1 comment

Comments

Projects
None yet
4 participants
@ThadHouse

ThadHouse commented Jan 22, 2017

One thing that always bugged me about the msdn documentation was that from a doc, there was no easy access to all the interfaces on a class. There would be the Syntax block, which still exists in docfx, but you couldn't actually click on the interfaces to get to their definition. It would be nice if the generated docs would have a way to do this.

My suggestion would be to add a block below Inherited Members to be something like "Implemented Interfaces", with links to all the implemented interfaces. That way it would be easy to see exactly what an interface definition is.

The other suggestion would be to make the interface and inheritance tree in the Syntax block clickable, so those would be links to their specific interfaces.

@vwxyzh

This comment has been minimized.

Show comment
Hide comment
@vwxyzh

vwxyzh May 3, 2017

Contributor

@ThadHouse , a clickable syntax block seems better, but it takes time, let us trace it in #1620.
For now, we will update default template with "Implemented Interfaces" in next month (v2.18).

Contributor

vwxyzh commented May 3, 2017

@ThadHouse , a clickable syntax block seems better, but it takes time, let us trace it in #1620.
For now, we will update default template with "Implemented Interfaces" in next month (v2.18).

@vwxyzh vwxyzh added this to the v2.18 milestone May 3, 2017

@vwxyzh vwxyzh assigned superyyrrzz and unassigned vwxyzh May 9, 2017

@vicancy vicancy modified the milestones: v2.19, v2.18 Jun 6, 2017

@vicancy vicancy modified the milestones: v2.20, v2.19 Jun 15, 2017

@vicancy vicancy modified the milestones: v2.21, v2.20 Jul 10, 2017

@vwxyzh vwxyzh modified the milestones: v2.23, v2.22 Aug 2, 2017

@vicancy vicancy closed this Sep 15, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment