dotnet / dotnet/docfx

Invalid link with seealso tag

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

Description

**Describe the bug**

The generated link for `seealso` tag are invalid when cref attribute points to a type in the same assembly:

I have the following doc comment:

```
/// A nice operation similar to .
///
```

Building with docfx produces the following warning:

```
docfx_project\api\MyApp.MyClass.yml: warning InvalidBookmark: Invalid link:
'MyOtherOperation'. The file api/MyApp.MyOtherClass.yml doesn't contain a bookmark named 'MyApp.MyOtherClass.MyOtherOperation(System.String,System.Int32)'.
```

For the `see` tag the generated link is correct:

```
/api/MyApp.MyOtherClass.html#MyApp_MyOtherClass_MyOtherOperation_System_String_System_Int32_
```

For the `seealso` tag it is not correct

```
/api/MyApp.MyOtherClass.html#MyApp.MyOtherClass.MyOtherOperation(System.String,System.Int32)
```

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.