We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
Describe the bug* Cross-reference from markdown to member functions seems to only work for parameterless functions, e.g.
Link to `Class1.g`: [g](xref:ClassLibrary1.Class1.g)
works and correctly links to ClassLibrary1.Class1.g() while
ClassLibrary1.Class1.g()
Link to `Class1.f`: [f](xref:ClassLibrary1.Class1.f) Link to `Class1.f(int)`: [f(int)](xref:ClassLibrary1.Class1.f(int))
both don't link to ClassLibrary1.Class1.f(int).
ClassLibrary1.Class1.f(int)
Linking from inside the API documentation (<see cref="ClassLibrary1.Class1.f(int)"/>, <see cref="ClassLibrary1.Class1.g()"/>) works fine.
<see cref="ClassLibrary1.Class1.f(int)"/>
<see cref="ClassLibrary1.Class1.g()"/>
To Reproduce Steps to reproduce the behavior: Run docfx in the docfx_project directory of my test project: https://github.com/TIS-Tim/docfx-markdown-cross-reference
Expected behavior Generate correct links when cross-referencing API documentation from markdown.
Context
The text was updated successfully, but these errors were encountered:
The xref syntax works a bit differently than cref. This should work: [](xref:ClassLibrary1.Class1.f(System.Int32)).
xref
cref
[](xref:ClassLibrary1.Class1.f(System.Int32))
You can find the correct syntax by searching for uid: in the generated YAML files.
uid:
Sorry, something went wrong.
@yufeih
Thank you!
You are totally right. The cross-referencing tool obviously doesn't know the C#-specific aliases of the .net types.
No branches or pull requests
Describe the bug*
Cross-reference from markdown to member functions seems to only work for parameterless functions, e.g.
works and correctly links to
ClassLibrary1.Class1.g()
whileboth don't link to
ClassLibrary1.Class1.f(int)
.Linking from inside the API documentation (
<see cref="ClassLibrary1.Class1.f(int)"/>
,<see cref="ClassLibrary1.Class1.g()"/>
) works fine.To Reproduce
Steps to reproduce the behavior:
Run docfx in the docfx_project directory of my test project:
https://github.com/TIS-Tim/docfx-markdown-cross-reference
Expected behavior
Generate correct links when cross-referencing API documentation from markdown.
Context
The text was updated successfully, but these errors were encountered: