dotnet / dotnet/docfx

Missing references when using xref and the generated xrefmap.yml

Open
#7,746 0 comments 2 reactions 0 assignees View on GitHub
dotnet
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 11m
Merged PRs (30d)
10

Description

**Operating System**: `Windows`

**DocFX Version Used**: 2.58.9

**Template used**: see attached zip file.

**Steps to Reproduce**:
[Reproduce.zip](https://github.com/dotnet/docfx/files/7661487/Reproduce.zip)
1. Download & Unzip the attached file
2. dotnet build .\Library\Library.csproj
3. dotnet build .\Project\Project.csproj
4. docfx .\Library\docfx.json
5. docfx .\Project\docfx.json

**Expected Behavior**:
The `Project.Main` should have clickable references to the functions and properties it inherits from `Library.Class1`.

**Actual Behavior**:
References to types in the linked library documentation don't work, with one exception. **Functions that have parameters** are referenced as expected. This seems to work for all use cases as far as I know. Like the generated inheritance list or when manually added in the documentation with a ``.
The references don't work for all other properties or functions without a parameter, for those the full name is displayed.

I suspect this issue is has the same cause as https://github.com/dotnet/docfx/issues/4792 & https://github.com/dotnet/docfx/issues/5264. As I experience the same issues with properties and interfaces.
I can't find a notable difference in the generated `xrefmap.yml` between the types that work and that don't.

Image of documentation site. Click to open.

![DocSite](https://user-images.githubusercontent.com/62928506/144867784-7e619c7b-eb64-4c14-99b5-648caa84a93d.png)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.