charleslemaux/Mirror
1
0
Fork 0
mirror of https://github.com/MirrorNetworking/Mirror.git synced 2024-11-18 11:00:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix: broken links to documentation

Browse Source
This commit is contained in:
MrGadget1024 2020-11-23 10:59:11 -05:00
parent e0fb14feea
commit fb8c3c4736
28 changed files with 28 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Assets/Mirror/Cloud/ApiConnector.cs
View File

@ -16,7 +16,7 @@ public interface IApiConnector
/// </summary> /// </summary>
[DisallowMultipleComponent] [DisallowMultipleComponent]
[AddComponentMenu("Network/CloudServices/ApiConnector")] [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 public class ApiConnector : MonoBehaviour, IApiConnector, ICoroutineRunner
{ {
#region Inspector #region Inspector

2
Assets/Mirror/Components/Discovery/NetworkDiscoveryBase.cs
View File

@ -16,7 +16,7 @@ namespace Mirror.Discovery
/// <see cref="NetworkDiscovery">NetworkDiscovery</see> for a sample implementation /// <see cref="NetworkDiscovery">NetworkDiscovery</see> for a sample implementation
/// </summary> /// </summary>
[DisallowMultipleComponent] [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 public abstract class NetworkDiscoveryBase<Request, Response> : MonoBehaviour
where Request : NetworkMessage where Request : NetworkMessage
where Response : NetworkMessage where Response : NetworkMessage

2
Assets/Mirror/Components/Discovery/NetworkDiscoveryHUD.cs
View File

@ -5,7 +5,7 @@ namespace Mirror.Discovery
{ {
[DisallowMultipleComponent] [DisallowMultipleComponent]
[AddComponentMenu("Network/NetworkDiscoveryHUD")] [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))] [RequireComponent(typeof(NetworkDiscovery))]
public class NetworkDiscoveryHUD : MonoBehaviour public class NetworkDiscoveryHUD : MonoBehaviour
{ {

2
Assets/Mirror/Components/Experimental/NetworkLerpRigidbody.cs
View File

@ -3,7 +3,7 @@
namespace Mirror.Experimental namespace Mirror.Experimental
{ {
[AddComponentMenu("Network/Experimental/NetworkLerpRigidbody")] [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 public class NetworkLerpRigidbody : NetworkBehaviour
{ {
[Header("Settings")] [Header("Settings")]

2
Assets/Mirror/Components/Experimental/NetworkRigidbody.cs
View File

@ -3,7 +3,7 @@
namespace Mirror.Experimental namespace Mirror.Experimental
{ {
[AddComponentMenu("Network/Experimental/NetworkRigidbody")] [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 public class NetworkRigidbody : NetworkBehaviour
{ {
static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkRigidbody)); static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkRigidbody));

2
Assets/Mirror/Components/Experimental/NetworkTransform.cs
View File

@ -4,7 +4,7 @@ namespace Mirror.Experimental
{ {
[DisallowMultipleComponent] [DisallowMultipleComponent]
[AddComponentMenu("Network/Experimental/NetworkTransformExperimental")] [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 public class NetworkTransform : NetworkTransformBase
{ {
protected override Transform targetTransform => transform; protected override Transform targetTransform => transform;

2
Assets/Mirror/Components/Experimental/NetworkTransformChild.cs
View File

@ -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> /// <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> /// </summary>
[AddComponentMenu("Network/Experimental/NetworkTransformChildExperimentalExperimental")] [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 public class NetworkTransformChild : NetworkTransformBase
{ {
[Header("Target")] [Header("Target")]

2
Assets/Mirror/Components/NetworkAnimator.cs
View File

@ -15,7 +15,7 @@ namespace Mirror
/// </remarks> /// </remarks>
[AddComponentMenu("Network/NetworkAnimator")] [AddComponentMenu("Network/NetworkAnimator")]
[RequireComponent(typeof(NetworkIdentity))] [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 public class NetworkAnimator : NetworkBehaviour
{ {
static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkAnimator)); static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkAnimator));

2
Assets/Mirror/Components/NetworkLobbyManager.cs
View File

@ -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> /// <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> /// </remarks>
[AddComponentMenu("Network/NetworkLobbyManager")] [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")] [Obsolete("Use / inherit from NetworkRoomManager instead")]
public class NetworkLobbyManager : NetworkRoomManager { } public class NetworkLobbyManager : NetworkRoomManager { }
} }

2
Assets/Mirror/Components/NetworkLobbyPlayer.cs
View File

@ -9,7 +9,7 @@ namespace Mirror
/// </summary> /// </summary>
[DisallowMultipleComponent] [DisallowMultipleComponent]
[AddComponentMenu("Network/NetworkLobbyPlayer")] [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")] [Obsolete("Use / inherit from NetworkRoomPlayer instead")]
public class NetworkLobbyPlayer : NetworkRoomPlayer { } public class NetworkLobbyPlayer : NetworkRoomPlayer { }
} }

2
Assets/Mirror/Components/NetworkMatchChecker.cs
View File

@ -12,7 +12,7 @@ namespace Mirror
[DisallowMultipleComponent] [DisallowMultipleComponent]
[AddComponentMenu("Network/NetworkMatchChecker")] [AddComponentMenu("Network/NetworkMatchChecker")]
[RequireComponent(typeof(NetworkIdentity))] [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 public class NetworkMatchChecker : NetworkVisibility
{ {
static readonly Dictionary<Guid, HashSet<NetworkIdentity>> matchPlayers = new Dictionary<Guid, HashSet<NetworkIdentity>>(); static readonly Dictionary<Guid, HashSet<NetworkIdentity>> matchPlayers = new Dictionary<Guid, HashSet<NetworkIdentity>>();

2
Assets/Mirror/Components/NetworkPingDisplay.cs
View File

@ -7,7 +7,7 @@ namespace Mirror
/// </summary> /// </summary>
[DisallowMultipleComponent] [DisallowMultipleComponent]
[AddComponentMenu("Network/NetworkPingDisplay")] [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 class NetworkPingDisplay : MonoBehaviour
{ {
public bool showPing = true; public bool showPing = true;

2
Assets/Mirror/Components/NetworkProximityChecker.cs
View File

@ -9,7 +9,7 @@ namespace Mirror
/// </summary> /// </summary>
[AddComponentMenu("Network/NetworkProximityChecker")] [AddComponentMenu("Network/NetworkProximityChecker")]
[RequireComponent(typeof(NetworkIdentity))] [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 public class NetworkProximityChecker : NetworkVisibility
{ {
/// <summary> /// <summary>

2
Assets/Mirror/Components/NetworkRoomManager.cs
View File

@ -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> /// <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> /// </remarks>
[AddComponentMenu("Network/NetworkRoomManager")] [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 public class NetworkRoomManager : NetworkManager
{ {
static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkRoomManager)); static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkRoomManager));

2
Assets/Mirror/Components/NetworkRoomPlayer.cs
View File

@ -8,7 +8,7 @@ namespace Mirror
/// </summary> /// </summary>
[DisallowMultipleComponent] [DisallowMultipleComponent]
[AddComponentMenu("Network/NetworkRoomPlayer")] [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 public class NetworkRoomPlayer : NetworkBehaviour
{ {
static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkRoomPlayer)); static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkRoomPlayer));

2
Assets/Mirror/Components/NetworkSceneChecker.cs
View File

@ -12,7 +12,7 @@ namespace Mirror
[DisallowMultipleComponent] [DisallowMultipleComponent]
[AddComponentMenu("Network/NetworkSceneChecker")] [AddComponentMenu("Network/NetworkSceneChecker")]
[RequireComponent(typeof(NetworkIdentity))] [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 public class NetworkSceneChecker : NetworkVisibility
{ {
static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkSceneChecker)); static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkSceneChecker));

2
Assets/Mirror/Components/NetworkTransform.cs
View File

@ -4,7 +4,7 @@ namespace Mirror
{ {
[DisallowMultipleComponent] [DisallowMultipleComponent]
[AddComponentMenu("Network/NetworkTransform")] [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 public class NetworkTransform : NetworkTransformBase
{ {
protected override Transform targetComponent => transform; protected override Transform targetComponent => transform;

2
Assets/Mirror/Components/NetworkTransformChild.cs
View File

@ -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> /// <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> /// </summary>
[AddComponentMenu("Network/NetworkTransformChild")] [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 public class NetworkTransformChild : NetworkTransformBase
{ {
[Header("Target")] [Header("Target")]

2
Assets/Mirror/Examples/Basic/Scripts/BasicNetManager.cs
View File

@ -1,7 +1,7 @@
using UnityEngine; 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 API Reference: https://mirror-networking.com/docs/api/Mirror.NetworkManager.html
*/ */

2
Assets/Mirror/Runtime/Logging/NetworkHeadlessLogger.cs
View File

@ -7,7 +7,7 @@ namespace Mirror.Logging
/// </summary> /// </summary>
[DisallowMultipleComponent] [DisallowMultipleComponent]
[AddComponentMenu("Network/NetworkHeadlessLogger")] [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 public class NetworkHeadlessLogger : MonoBehaviour
{ {
#pragma warning disable CS0414 // unused private members #pragma warning disable CS0414 // unused private members

2
Assets/Mirror/Runtime/Logging/NetworkLogSettings.cs
View File

@ -7,7 +7,7 @@ namespace Mirror.Logging
/// </summary> /// </summary>
[DisallowMultipleComponent] [DisallowMultipleComponent]
[AddComponentMenu("Network/NetworkLogSettings")] [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 public class NetworkLogSettings : MonoBehaviour
{ {
[Header("Log Settings Asset")] [Header("Log Settings Asset")]

2
Assets/Mirror/Runtime/NetworkAuthenticator.cs
View File

@ -12,7 +12,7 @@ namespace Mirror
/// <summary> /// <summary>
/// Base class for implementing component-based authentication during the Connect phase /// Base class for implementing component-based authentication during the Connect phase
/// </summary> /// </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 public abstract class NetworkAuthenticator : MonoBehaviour
{ {
[Header("Event Listeners (optional)")] [Header("Event Listeners (optional)")]

2
Assets/Mirror/Runtime/NetworkBehaviour.cs
View File

@ -20,7 +20,7 @@ public enum SyncMode { Observers, Owner }
/// </remarks> /// </remarks>
[AddComponentMenu("")] [AddComponentMenu("")]
[RequireComponent(typeof(NetworkIdentity))] [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 public abstract class NetworkBehaviour : MonoBehaviour
{ {
static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkBehaviour)); static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkBehaviour));

2
Assets/Mirror/Runtime/NetworkIdentity.cs
View File

@ -105,7 +105,7 @@ namespace Mirror
/// </remarks> /// </remarks>
[DisallowMultipleComponent] [DisallowMultipleComponent]
[AddComponentMenu("Network/NetworkIdentity")] [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 public sealed class NetworkIdentity : MonoBehaviour
{ {
static readonly ILogger logger = LogFactory.GetLogger<NetworkIdentity>(); static readonly ILogger logger = LogFactory.GetLogger<NetworkIdentity>();

2
Assets/Mirror/Runtime/NetworkManager.cs
View File

@ -20,7 +20,7 @@ public enum NetworkManagerMode { Offline, ServerOnly, ClientOnly, Host }
[DisallowMultipleComponent] [DisallowMultipleComponent]
[AddComponentMenu("Network/NetworkManager")] [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 public class NetworkManager : MonoBehaviour
{ {
static readonly ILogger logger = LogFactory.GetLogger<NetworkManager>(); static readonly ILogger logger = LogFactory.GetLogger<NetworkManager>();

2
Assets/Mirror/Runtime/NetworkManagerHUD.cs
View File

@ -11,7 +11,7 @@ namespace Mirror
[DisallowMultipleComponent] [DisallowMultipleComponent]
[AddComponentMenu("Network/NetworkManagerHUD")] [AddComponentMenu("Network/NetworkManagerHUD")]
[RequireComponent(typeof(NetworkManager))] [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 public class NetworkManagerHUD : MonoBehaviour
{ {
NetworkManager manager; NetworkManager manager;

2
Assets/Mirror/Runtime/NetworkStartPosition.cs
View File

@ -8,7 +8,7 @@ namespace Mirror
/// </summary> /// </summary>
[DisallowMultipleComponent] [DisallowMultipleComponent]
[AddComponentMenu("Network/NetworkStartPosition")] [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 class NetworkStartPosition : MonoBehaviour
{ {
public void Awake() public void Awake()

2
Assets/Mirror/Runtime/Transport/FallbackTransport.cs
View File

@ -6,7 +6,7 @@
namespace Mirror 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 class FallbackTransport : Transport
{ {
public Transport[] transports; public Transport[] transports;