Fix xref links to .NET types not resolving

RiptideNetworking · Nov 27, 2023 · 4f3790d · 4f3790d
1 parent 54a5137
commit 4f3790d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/Docs/docfx.json b/Docs/docfx.json
@@ -86,6 +86,9 @@
             "default",
             "templates/riptide"
         ],
+        "xref": [
+            "https://learn.microsoft.com/en-us/dotnet/.xrefmap.json"
+        ],
         "sitemap": {
             "baseUrl": "https://riptide.tomweiland.net/"
         },

diff --git a/Docs/manual/updates/release-notes/v2.1.0.md b/Docs/manual/updates/release-notes/v2.1.0.md
@@ -38,9 +38,9 @@ For a full list of source code changes, check out the [version comparison](https
 - Changed <code><xref:Riptide.Message.MaxPayloadSize?displayProperty=nameWithType></code> setter's error logs to exceptions.
 - Disabled Nagle's algorithm in the TCP transport.
 - Removed the unnecessary 65 second limit on <code><xref:Riptide.Connection.TimeoutTime?displayProperty=nameWithType></code> and <code><xref:Riptide.Peer.HeartbeatInterval?displayProperty=nameWithType></code>.
-- Made <code><xref:Riptide.Utils.PriorityQueue`2></code> publicly accessible and removed its internal use of `List<T>`.
+- Made <code><xref:Riptide.Utils.PriorityQueue`2></code> publicly accessible and removed its internal use of <code><xref:System.Collections.Generic.List`1></code>.
 - Removed the unnecessary `AckExtra` <code><xref:Riptide.Transports.MessageHeader></code> type.
-- Stopped using `DateTime` for calculating timeouts.
+- Stopped using <code><xref:System.DateTime></code> for calculating timeouts.
 - Updated DocFX to v2.70.1.
 
 ## Fixes
@@ -54,7 +54,7 @@ For a full list of source code changes, check out the [version comparison](https
 - Fixed incorrect "unknown reason" rejection log when an already-connected connection was rejected ([#84](https://github.com/RiptideNetworking/Riptide/issues/84)).
 - Fixed errors that occurred when various <code><xref:Riptide.Server></code> properties were accessed before the first player connected ([#86](https://github.com/RiptideNetworking/Riptide/issues/86)).
 - Fixed the TCP transport's improper handling of large packets ([#92](https://github.com/RiptideNetworking/Riptide/issues/92)).
-- Fixed unhandled `SocketException`s when sending data, such as the one that occurred when a <code><xref:Riptide.Client></code> with no internet connection attempted to connect ([#102](https://github.com/RiptideNetworking/Riptide/pull/102)).
+- Fixed unhandled <code><xref:System.Net.Sockets.SocketException></code>s when sending data, such as the one that occurred when a <code><xref:Riptide.Client></code> with no internet connection attempted to connect ([#102](https://github.com/RiptideNetworking/Riptide/pull/102)).
 - Fixed unintended timeout when a `Client` would disconnect and reconnect again in quick succession ([#105](https://github.com/RiptideNetworking/Riptide/issues/105)).
 - Fixed an infinite loop when a `Server` was started with a `maxClientCount` of 65,535 ([#111](https://github.com/RiptideNetworking/Riptide/issues/111)).
 - Fixed an issue with the TCP transport that caused connections to be rejected shortly after they were accepted and fully connected (similar to [SteamTransport#1](https://github.com/RiptideNetworking/SteamTransport/issues/1)).