fix: broken links to documentation

2024-11-18 02:50:32 +00:00 · 2020-11-23 10:59:11 -05:00 · 2020-11-23 10:59:11 -05:00 · fb8c3c4736
commit fb8c3c4736
parent e0fb14feea
28 changed files with 28 additions and 28 deletions
--- a/Assets/Mirror/Cloud/ApiConnector.cs
+++ b/Assets/Mirror/Cloud/ApiConnector.cs
@ -16,7 +16,7 @@ public interface IApiConnector
    /// </summary>
    [DisallowMultipleComponent]
    [AddComponentMenu("Network/CloudServices/ApiConnector")]
-    [HelpURL("https://mirror-networking.com/docs/CloudServices/ApiConnector.html")]
+    [HelpURL("https://mirror-networking.com/docs/api/Mirror.Cloud.ApiConnector.html")]
    public class ApiConnector : MonoBehaviour, IApiConnector, ICoroutineRunner
    {
        #region Inspector
--- a/Assets/Mirror/Components/Discovery/NetworkDiscoveryBase.cs
+++ b/Assets/Mirror/Components/Discovery/NetworkDiscoveryBase.cs
@ -16,7 +16,7 @@ namespace Mirror.Discovery
    /// <see cref="NetworkDiscovery">NetworkDiscovery</see> for a sample implementation
    /// </summary>
    [DisallowMultipleComponent]
-    [HelpURL("https://mirror-networking.com/docs/Components/NetworkDiscovery.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Components/NetworkDiscovery.html")]
    public abstract class NetworkDiscoveryBase<Request, Response> : MonoBehaviour
        where Request : NetworkMessage
        where Response : NetworkMessage
--- a/Assets/Mirror/Components/Discovery/NetworkDiscoveryHUD.cs
+++ b/Assets/Mirror/Components/Discovery/NetworkDiscoveryHUD.cs
@ -5,7 +5,7 @@ namespace Mirror.Discovery
 {
    [DisallowMultipleComponent]
    [AddComponentMenu("Network/NetworkDiscoveryHUD")]
-    [HelpURL("https://mirror-networking.com/docs/Components/NetworkDiscovery.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Components/NetworkDiscovery.html")]
    [RequireComponent(typeof(NetworkDiscovery))]
    public class NetworkDiscoveryHUD : MonoBehaviour
    {
--- a/Assets/Mirror/Components/Experimental/NetworkLerpRigidbody.cs
+++ b/Assets/Mirror/Components/Experimental/NetworkLerpRigidbody.cs
@ -3,7 +3,7 @@
 namespace Mirror.Experimental
 {
    [AddComponentMenu("Network/Experimental/NetworkLerpRigidbody")]
-    [HelpURL("https://mirror-networking.com/docs/Components/NetworkLerpRigidbody.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Components/NetworkLerpRigidbody.html")]
    public class NetworkLerpRigidbody : NetworkBehaviour
    {
        [Header("Settings")]
--- a/Assets/Mirror/Components/Experimental/NetworkRigidbody.cs
+++ b/Assets/Mirror/Components/Experimental/NetworkRigidbody.cs
@ -3,7 +3,7 @@
 namespace Mirror.Experimental
 {
    [AddComponentMenu("Network/Experimental/NetworkRigidbody")]
-    [HelpURL("https://mirror-networking.com/docs/Components/NetworkRigidbody.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Components/NetworkRigidbody.html")]
    public class NetworkRigidbody : NetworkBehaviour
    {
        static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkRigidbody));
--- a/Assets/Mirror/Components/Experimental/NetworkTransform.cs
+++ b/Assets/Mirror/Components/Experimental/NetworkTransform.cs
@ -4,7 +4,7 @@ namespace Mirror.Experimental
 {
    [DisallowMultipleComponent]
    [AddComponentMenu("Network/Experimental/NetworkTransformExperimental")]
-    [HelpURL("https://mirror-networking.com/docs/Components/NetworkTransform.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Components/NetworkTransform.html")]
    public class NetworkTransform : NetworkTransformBase
    {
        protected override Transform targetTransform => transform;
--- a/Assets/Mirror/Components/Experimental/NetworkTransformChild.cs
+++ b/Assets/Mirror/Components/Experimental/NetworkTransformChild.cs
@ -7,7 +7,7 @@ namespace Mirror.Experimental
    /// <para>There must be a NetworkTransform on the root object of the hierarchy. There can be multiple NetworkTransformChild components on an object. This does not use physics for synchronization, it simply synchronizes the localPosition and localRotation of the child transform and lerps towards the recieved values.</para>
    /// </summary>
    [AddComponentMenu("Network/Experimental/NetworkTransformChildExperimentalExperimental")]
-    [HelpURL("https://mirror-networking.com/docs/Components/NetworkTransformChild.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Components/NetworkTransformChild.html")]
    public class NetworkTransformChild : NetworkTransformBase
    {
        [Header("Target")]
--- a/Assets/Mirror/Components/NetworkAnimator.cs
+++ b/Assets/Mirror/Components/NetworkAnimator.cs
@ -15,7 +15,7 @@ namespace Mirror
    /// </remarks>
    [AddComponentMenu("Network/NetworkAnimator")]
    [RequireComponent(typeof(NetworkIdentity))]
-    [HelpURL("https://mirror-networking.com/docs/Components/NetworkAnimator.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Components/NetworkAnimator.html")]
    public class NetworkAnimator : NetworkBehaviour
    {
        static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkAnimator));
--- a/Assets/Mirror/Components/NetworkLobbyManager.cs
+++ b/Assets/Mirror/Components/NetworkLobbyManager.cs
@ -12,7 +12,7 @@ namespace Mirror
    /// <para>The OnLobby*() functions have empty implementations on the NetworkLobbyManager base class, so the base class functions do not have to be called.</para>
    /// </remarks>
    [AddComponentMenu("Network/NetworkLobbyManager")]
-    [HelpURL("https://mirror-networking.com/docs/Components/NetworkRoomManager.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Components/NetworkRoomManager.html")]
    [Obsolete("Use / inherit from NetworkRoomManager instead")]
    public class NetworkLobbyManager : NetworkRoomManager { }
 }
--- a/Assets/Mirror/Components/NetworkLobbyPlayer.cs
+++ b/Assets/Mirror/Components/NetworkLobbyPlayer.cs
@ -9,7 +9,7 @@ namespace Mirror
    /// </summary>
    [DisallowMultipleComponent]
    [AddComponentMenu("Network/NetworkLobbyPlayer")]
-    [HelpURL("https://mirror-networking.com/docs/Components/NetworkRoomPlayer.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Components/NetworkRoomPlayer.html")]
    [Obsolete("Use / inherit from NetworkRoomPlayer instead")]
    public class NetworkLobbyPlayer : NetworkRoomPlayer { }
 }
--- a/Assets/Mirror/Components/NetworkMatchChecker.cs
+++ b/Assets/Mirror/Components/NetworkMatchChecker.cs
@ -12,7 +12,7 @@ namespace Mirror
    [DisallowMultipleComponent]
    [AddComponentMenu("Network/NetworkMatchChecker")]
    [RequireComponent(typeof(NetworkIdentity))]
-    [HelpURL("https://mirror-networking.com/docs/Components/NetworkMatchChecker.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Components/NetworkMatchChecker.html")]
    public class NetworkMatchChecker : NetworkVisibility
    {
        static readonly Dictionary<Guid, HashSet<NetworkIdentity>> matchPlayers = new Dictionary<Guid, HashSet<NetworkIdentity>>();
--- a/Assets/Mirror/Components/NetworkPingDisplay.cs
+++ b/Assets/Mirror/Components/NetworkPingDisplay.cs
@ -7,7 +7,7 @@ namespace Mirror
    /// </summary>
    [DisallowMultipleComponent]
    [AddComponentMenu("Network/NetworkPingDisplay")]
-    [HelpURL("https://mirror-networking.com/docs/Components/NetworkPingDisplay.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Components/NetworkPingDisplay.html")]
    public class NetworkPingDisplay : MonoBehaviour
    {
        public bool showPing = true;
--- a/Assets/Mirror/Components/NetworkProximityChecker.cs
+++ b/Assets/Mirror/Components/NetworkProximityChecker.cs
@ -9,7 +9,7 @@ namespace Mirror
    /// </summary>
    [AddComponentMenu("Network/NetworkProximityChecker")]
    [RequireComponent(typeof(NetworkIdentity))]
-    [HelpURL("https://mirror-networking.com/docs/Components/NetworkProximityChecker.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Components/NetworkProximityChecker.html")]
    public class NetworkProximityChecker : NetworkVisibility
    {
        /// <summary>
--- a/Assets/Mirror/Components/NetworkRoomManager.cs
+++ b/Assets/Mirror/Components/NetworkRoomManager.cs
@ -15,7 +15,7 @@ namespace Mirror
    /// <para>The OnRoom*() functions have empty implementations on the NetworkRoomManager base class, so the base class functions do not have to be called.</para>
    /// </remarks>
    [AddComponentMenu("Network/NetworkRoomManager")]
-    [HelpURL("https://mirror-networking.com/docs/Components/NetworkRoomManager.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Components/NetworkRoomManager.html")]
    public class NetworkRoomManager : NetworkManager
    {
        static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkRoomManager));
--- a/Assets/Mirror/Components/NetworkRoomPlayer.cs
+++ b/Assets/Mirror/Components/NetworkRoomPlayer.cs
@ -8,7 +8,7 @@ namespace Mirror
    /// </summary>
    [DisallowMultipleComponent]
    [AddComponentMenu("Network/NetworkRoomPlayer")]
-    [HelpURL("https://mirror-networking.com/docs/Components/NetworkRoomPlayer.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Components/NetworkRoomPlayer.html")]
    public class NetworkRoomPlayer : NetworkBehaviour
    {
        static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkRoomPlayer));
--- a/Assets/Mirror/Components/NetworkSceneChecker.cs
+++ b/Assets/Mirror/Components/NetworkSceneChecker.cs
@ -12,7 +12,7 @@ namespace Mirror
    [DisallowMultipleComponent]
    [AddComponentMenu("Network/NetworkSceneChecker")]
    [RequireComponent(typeof(NetworkIdentity))]
-    [HelpURL("https://mirror-networking.com/docs/Components/NetworkSceneChecker.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Components/NetworkSceneChecker.html")]
    public class NetworkSceneChecker : NetworkVisibility
    {
        static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkSceneChecker));
--- a/Assets/Mirror/Components/NetworkTransform.cs
+++ b/Assets/Mirror/Components/NetworkTransform.cs
@ -4,7 +4,7 @@ namespace Mirror
 {
    [DisallowMultipleComponent]
    [AddComponentMenu("Network/NetworkTransform")]
-    [HelpURL("https://mirror-networking.com/docs/Components/NetworkTransform.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Components/NetworkTransform.html")]
    public class NetworkTransform : NetworkTransformBase
    {
        protected override Transform targetComponent => transform;
--- a/Assets/Mirror/Components/NetworkTransformChild.cs
+++ b/Assets/Mirror/Components/NetworkTransformChild.cs
@ -7,7 +7,7 @@ namespace Mirror
    /// <para>There must be a NetworkTransform on the root object of the hierarchy. There can be multiple NetworkTransformChild components on an object. This does not use physics for synchronization, it simply synchronizes the localPosition and localRotation of the child transform and lerps towards the recieved values.</para>
    /// </summary>
    [AddComponentMenu("Network/NetworkTransformChild")]
-    [HelpURL("https://mirror-networking.com/docs/Components/NetworkTransformChild.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Components/NetworkTransformChild.html")]
    public class NetworkTransformChild : NetworkTransformBase
    {
        [Header("Target")]
--- a/Assets/Mirror/Examples/Basic/Scripts/BasicNetManager.cs
+++ b/Assets/Mirror/Examples/Basic/Scripts/BasicNetManager.cs
@ -1,7 +1,7 @@
 using UnityEngine;

 /*
-	Documentation: https://mirror-networking.com/docs/Components/NetworkManager.html
+	Documentation: https://mirror-networking.com/docs/Articles/Components/NetworkManager.html
 	API Reference: https://mirror-networking.com/docs/api/Mirror.NetworkManager.html
 */

--- a/Assets/Mirror/Runtime/Logging/NetworkHeadlessLogger.cs
+++ b/Assets/Mirror/Runtime/Logging/NetworkHeadlessLogger.cs
@ -7,7 +7,7 @@ namespace Mirror.Logging
    /// </summary>
    [DisallowMultipleComponent]
    [AddComponentMenu("Network/NetworkHeadlessLogger")]
-    [HelpURL("https://mirror-networking.com/docs/Components/NetworkHeadlessLogger.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Components/NetworkHeadlessLogger.html")]
    public class NetworkHeadlessLogger : MonoBehaviour
    {
 #pragma warning disable CS0414 // unused private members
--- a/Assets/Mirror/Runtime/Logging/NetworkLogSettings.cs
+++ b/Assets/Mirror/Runtime/Logging/NetworkLogSettings.cs
@ -7,7 +7,7 @@ namespace Mirror.Logging
    /// </summary>
    [DisallowMultipleComponent]
    [AddComponentMenu("Network/NetworkLogSettings")]
-    [HelpURL("https://mirror-networking.com/docs/Components/NetworkLogSettings.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Components/NetworkLogSettings.html")]
    public class NetworkLogSettings : MonoBehaviour
    {
        [Header("Log Settings Asset")]
--- a/Assets/Mirror/Runtime/NetworkAuthenticator.cs
+++ b/Assets/Mirror/Runtime/NetworkAuthenticator.cs
@ -12,7 +12,7 @@ namespace Mirror
    /// <summary>
    /// Base class for implementing component-based authentication during the Connect phase
    /// </summary>
-    [HelpURL("https://mirror-networking.com/docs/Guides/Authentication.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Guides/Authentication.html")]
    public abstract class NetworkAuthenticator : MonoBehaviour
    {
        [Header("Event Listeners (optional)")]
--- a/Assets/Mirror/Runtime/NetworkBehaviour.cs
+++ b/Assets/Mirror/Runtime/NetworkBehaviour.cs
@ -20,7 +20,7 @@ public enum SyncMode { Observers, Owner }
    /// </remarks>
    [AddComponentMenu("")]
    [RequireComponent(typeof(NetworkIdentity))]
-    [HelpURL("https://mirror-networking.com/docs/Guides/NetworkBehaviour.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Guides/NetworkBehaviour.html")]
    public abstract class NetworkBehaviour : MonoBehaviour
    {
        static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkBehaviour));
--- a/Assets/Mirror/Runtime/NetworkIdentity.cs
+++ b/Assets/Mirror/Runtime/NetworkIdentity.cs
@ -105,7 +105,7 @@ namespace Mirror
    /// </remarks>
    [DisallowMultipleComponent]
    [AddComponentMenu("Network/NetworkIdentity")]
-    [HelpURL("https://mirror-networking.com/docs/Components/NetworkIdentity.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Components/NetworkIdentity.html")]
    public sealed class NetworkIdentity : MonoBehaviour
    {
        static readonly ILogger logger = LogFactory.GetLogger<NetworkIdentity>();
--- a/Assets/Mirror/Runtime/NetworkManager.cs
+++ b/Assets/Mirror/Runtime/NetworkManager.cs
@ -20,7 +20,7 @@ public enum NetworkManagerMode { Offline, ServerOnly, ClientOnly, Host }

    [DisallowMultipleComponent]
    [AddComponentMenu("Network/NetworkManager")]
-    [HelpURL("https://mirror-networking.com/docs/Components/NetworkManager.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Components/NetworkManager.html")]
    public class NetworkManager : MonoBehaviour
    {
        static readonly ILogger logger = LogFactory.GetLogger<NetworkManager>();
--- a/Assets/Mirror/Runtime/NetworkManagerHUD.cs
+++ b/Assets/Mirror/Runtime/NetworkManagerHUD.cs
@ -11,7 +11,7 @@ namespace Mirror
    [DisallowMultipleComponent]
    [AddComponentMenu("Network/NetworkManagerHUD")]
    [RequireComponent(typeof(NetworkManager))]
-    [HelpURL("https://mirror-networking.com/docs/Components/NetworkManagerHUD.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Components/NetworkManagerHUD.html")]
    public class NetworkManagerHUD : MonoBehaviour
    {
        NetworkManager manager;
--- a/Assets/Mirror/Runtime/NetworkStartPosition.cs
+++ b/Assets/Mirror/Runtime/NetworkStartPosition.cs
@ -8,7 +8,7 @@ namespace Mirror
    /// </summary>
    [DisallowMultipleComponent]
    [AddComponentMenu("Network/NetworkStartPosition")]
-    [HelpURL("https://mirror-networking.com/docs/Components/NetworkStartPosition.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Components/NetworkStartPosition.html")]
    public class NetworkStartPosition : MonoBehaviour
    {
        public void Awake()
--- a/Assets/Mirror/Runtime/Transport/FallbackTransport.cs
+++ b/Assets/Mirror/Runtime/Transport/FallbackTransport.cs
@ -6,7 +6,7 @@

 namespace Mirror
 {
-    [HelpURL("https://mirror-networking.com/docs/Transports/Fallback.html")]
+    [HelpURL("https://mirror-networking.com/docs/Articles/Transports/Fallback.html")]
    public class FallbackTransport : Transport
    {
        public Transport[] transports;