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

[Feature Request] Include API pages xref to xrefmap.yml when using ApiPage output format. #9677

Open
filzrev opened this issue Feb 2, 2024 · 1 comment
Labels
dotnet Generate .NET API reference docs

Comments

@filzrev
Copy link
Contributor

filzrev commented Feb 2, 2024

Is your feature request related to a problem? Please describe.
When using ApiPage metadata output format.
It contains uid as metadata. But it's not exposed to xrefmap.yml

So link to ApiPage with <xref:uid> is not working.

Describe the solution you'd like
Include ApiPage's xref info to xrefmap.yml and it can resolve API page with <xref:uid>.

@yufeih yufeih added the dotnet Generate .NET API reference docs label Feb 10, 2024
@filzrev
Copy link
Contributor Author

filzrev commented Apr 26, 2024

It seems API page cross references also not works when using outputFormat: apiPage.

Example

    public interface IDummyInterface{}
    
    /// <summary>
    /// Provides a built-in <see cref="IDummy"/>.
    /// </summary>
    public class DummyClass : IDummy
    {
        public string DummyProp { get; set; }
    }

<see cref="IDummy"/> tah is expected converted to link.
But it's rendered as plain span.

<span class="xref">RoslynAnalysis.DummyInterface</span>

And uid not found warning is not reported.

When using mref output format. it works as expected.

@filzrev filzrev changed the title [Feature Request] Include API pages xref to xrefmap.yml when using ApiPage` output format. [Feature Request] Include API pages xref to xrefmap.yml when using ApiPage output format. Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dotnet Generate .NET API reference docs
Projects
None yet
Development

No branches or pull requests

2 participants