1
<see cref="{some external type}" /> does not produce link, or produces wrong link
Problem reported by Steve Jackson - 2/25/2022 at 8:03 AM
Resolved
This is with GhostDoc Pro 2022.1.22020
Visual Studio 2022
Solution contains C# Class Libraries - .Net 6 LTS

When building a help document, where one of the tags includes a <see /> tag that references an external type (IE a type that is included in a referenced assembly) - either a link is not generated or an incorrect link is generated.

<see cref="SqlParameter"/> is rendered as [SqlParameter]

<see cref="T:Microsoft.Data.SqlClient.SqlParameter"/> is rendered as a link, which points to:
    msdn.microsoft.com/en-us/library/microsoft.data.sqlclient.sqlparameter.aspx
   This is redirected to: docs.microsoft.com/en-us/
However it should be pointing to:
   docs.microsoft.com/en-us/dotnet/api/microsoft.data.sqlclient.sqlparameter.-ctor?view=sqlclient-dotnet-standard-4.0

The project is currently using the 4.0 version, it's not yet been upgraded to the 4.1 version.

The fact that you have to prefix any external type with a T: is slightly irritating - but not a serious issue, I assume there is a good reason for having to do this.

Does anybody have a workaround or fix for the external documentation links not pointing to the correct place?

1 Reply

Reply to Thread
0
Misha Zhutov Replied
Employee Post
Hi Steve, 

Thank you for reporting that. We have fixed the issue. The fix will be available in the next public build.

Reply to Thread