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

Calculate .NET API URLs without xrefmap #8567

Closed
5 tasks done
yufeih opened this issue Mar 27, 2023 · 2 comments
Closed
5 tasks done

Calculate .NET API URLs without xrefmap #8567

yufeih opened this issue Mar 27, 2023 · 2 comments
Labels
dotnet: xml-comment XML comment for .NET API reference docs dotnet Generate .NET API reference docs
Milestone

Comments

@yufeih
Copy link
Contributor

yufeih commented Mar 27, 2023

Xrefmap represents an ID -> object mapping and is a general-purpose cross-referencing mechanism used in many places. For .NET API reference, using xrefmap as intermediary has limitations such as missing info for <inheritdoc />. In addition, the xref service in MSLearn for .NET BCL may be retired in the future. We’d like to move to a future where API URLs are calculated using URL patterns.

  • calculate MSLearn URL
  • calculate PDB symbol link URL
  • drop useCompatibilityFileName
  • calculate internal API cross-linking
  • allow cross-linking APIs to dependency sites
@yufeih yufeih added dotnet Generate .NET API reference docs dotnet: xml-comment XML comment for .NET API reference docs labels Mar 27, 2023
@yufeih yufeih added this to the Working Set milestone Mar 27, 2023
@KalleOlaviNiemitalo
Copy link

How is inheritdoc going to work with the uid-url mapping; will it require local xml doc files for the assemblies in which the interfaces and base classes are defined?

@yufeih
Copy link
Contributor Author

yufeih commented Mar 28, 2023

How is inheritdoc going to work with the uid-url mapping; will it require local xml doc files for the assemblies in which the interfaces and base classes are defined?

It'll work the same way as visual studio using XML doc file for assemblies and source code for C# files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dotnet: xml-comment XML comment for .NET API reference docs dotnet Generate .NET API reference docs
Projects
None yet
Development

No branches or pull requests

2 participants