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

fix #1096 move xmldocs to docs

Browse Source
This commit is contained in:
Paul Pacheco 2019-09-24 22:42:02 -05:00
parent 7dfaf05cee
commit db2e1488c1
17 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -15,7 +15,7 @@ namespace Mirror
[DisallowMultipleComponent]
[AddComponentMenu("Network/NetworkAnimator")]
[RequireComponent(typeof(NetworkIdentity))]
[HelpURL("https://mirror-networking.com/xmldocs/Components/NetworkAnimator.html")]
[HelpURL("https://mirror-networking.com/docs/Components/NetworkAnimator.html")]
public class NetworkAnimator : NetworkBehaviour
{
/// <summary>

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

@ -16,7 +16,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/xmldocs/Components/NetworkRoomManager.html")]
[HelpURL("https://mirror-networking.com/docs/Components/NetworkRoomManager.html")]
[Obsolete("Use / inherit from NetworkRoomManager instead")]
public class NetworkLobbyManager : NetworkRoomManager { }
}

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

@ -10,7 +10,7 @@ namespace Mirror
/// </summary>
[DisallowMultipleComponent]
[AddComponentMenu("Network/NetworkLobbyPlayer")]
[HelpURL("https://mirror-networking.com/xmldocs/Components/NetworkRoomPlayer.html")]
[HelpURL("https://mirror-networking.com/docs/Components/NetworkRoomPlayer.html")]
[Obsolete("Use / inherit from NetworkRoomPlayer instead")]
public class NetworkLobbyPlayer : NetworkRoomPlayer { }
}

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

@ -9,7 +9,7 @@ namespace Mirror
/// </summary>
[AddComponentMenu("Network/NetworkProximityChecker")]
[RequireComponent(typeof(NetworkIdentity))]
[HelpURL("https://mirror-networking.com/xmldocs/Components/NetworkProximityChecker.html")]
[HelpURL("https://mirror-networking.com/docs/Components/NetworkProximityChecker.html")]
public class NetworkProximityChecker : NetworkBehaviour
{
/// <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>
/// </remarks>
[AddComponentMenu("Network/NetworkRoomManager")]
[HelpURL("https://mirror-networking.com/xmldocs/Components/NetworkRoomManager.html")]
[HelpURL("https://mirror-networking.com/docs/Components/NetworkRoomManager.html")]
public class NetworkRoomManager : NetworkManager
{
public struct PendingPlayer

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

@ -9,7 +9,7 @@ namespace Mirror
/// </summary>
[DisallowMultipleComponent]
[AddComponentMenu("Network/NetworkRoomPlayer")]
[HelpURL("https://mirror-networking.com/xmldocs/Components/NetworkRoomPlayer.html")]
[HelpURL("https://mirror-networking.com/docs/Components/NetworkRoomPlayer.html")]
public class NetworkRoomPlayer : NetworkBehaviour
{
/// <summary>

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

@ -4,7 +4,7 @@ namespace Mirror
{
[DisallowMultipleComponent]
[AddComponentMenu("Network/NetworkTransform")]
[HelpURL("https://mirror-networking.com/xmldocs/Components/NetworkTransform.html")]
[HelpURL("https://mirror-networking.com/docs/Components/NetworkTransform.html")]
public class NetworkTransform : NetworkTransformBase
{
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>
/// </summary>
[AddComponentMenu("Network/NetworkTransformChild")]
[HelpURL("https://mirror-networking.com/xmldocs/Components/NetworkTransformChild.html")]
[HelpURL("https://mirror-networking.com/docs/Components/NetworkTransformChild.html")]
public class NetworkTransformChild : NetworkTransformBase
{
public Transform target;

2
Assets/Mirror/Readme.txt
View File

@ -8,7 +8,7 @@ Requirements:
Runtime .Net 4.x (Project Settings > Player > Other Settings)
Documentation:
https://mirror-networking.com/xmldocs/
https://mirror-networking.com/docs/
Support:
Discord: https://discordapp.com/invite/N9QVxbM

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

@ -12,7 +12,7 @@ namespace Mirror
/// <summary>
/// Base class for implementing component-based authentication during the Connect phase
/// </summary>
[HelpURL("https://mirror-networking.com/xmldocs/Concepts/Authentication.html")]
[HelpURL("https://mirror-networking.com/docs/Concepts/Authentication.html")]
public abstract class NetworkAuthenticator : MonoBehaviour
{
[Header("Event Listeners (optional)")]

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

@ -44,7 +44,7 @@ namespace Mirror
[ExecuteInEditMode]
[DisallowMultipleComponent]
[AddComponentMenu("Network/NetworkIdentity")]
[HelpURL("https://mirror-networking.com/xmldocs/Components/NetworkIdentity.html")]
[HelpURL("https://mirror-networking.com/docs/Components/NetworkIdentity.html")]
public sealed class NetworkIdentity : MonoBehaviour
{
// configuration

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

@ -19,7 +19,7 @@ public enum PlayerSpawnMethod
}
[AddComponentMenu("Network/NetworkManager")]
[HelpURL("https://mirror-networking.com/xmldocs/Components/NetworkManager.html")]
[HelpURL("https://mirror-networking.com/docs/Components/NetworkManager.html")]
public class NetworkManager : MonoBehaviour
{
/// <summary>

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

@ -12,7 +12,7 @@ namespace Mirror
[AddComponentMenu("Network/NetworkManagerHUD")]
[RequireComponent(typeof(NetworkManager))]
[EditorBrowsable(EditorBrowsableState.Never)]
[HelpURL("https://mirror-networking.com/xmldocs/Components/NetworkManagerHUD.html")]
[HelpURL("https://mirror-networking.com/docs/Components/NetworkManagerHUD.html")]
public class NetworkManagerHUD : MonoBehaviour
{
NetworkManager manager;

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

@ -8,7 +8,7 @@ namespace Mirror
/// </summary>
[DisallowMultipleComponent]
[AddComponentMenu("Network/NetworkStartPosition")]
[HelpURL("https://mirror-networking.com/xmldocs/Components/NetworkStartPosition.html")]
[HelpURL("https://mirror-networking.com/docs/Components/NetworkStartPosition.html")]
public class NetworkStartPosition : MonoBehaviour
{
public void Awake()

6
README.md
View File

@ -1,7 +1,7 @@
![Mirror Logo](https://i.imgur.com/MBpESqo.png)
[![Download](https://img.shields.io/badge/asset_store-brightgreen.svg)](https://www.assetstore.unity3d.com/#!/content/129321)
[![Documentation](https://img.shields.io/badge/documentation-brightgreen.svg)](https://mirror-networking.com/xmldocs)
[![Documentation](https://img.shields.io/badge/documentation-brightgreen.svg)](https://mirror-networking.com/docs)
[![Forum](https://img.shields.io/badge/forum-brightgreen.svg)](https://forum.unity.com/threads/mirror-networking-for-unity-aka-hlapi-community-edition.425437/)
[![donate](https://img.shields.io/badge/donations-brightgreen.svg)](https://www.patreon.com/MirrorNetworking)
[![Build status](https://img.shields.io/appveyor/ci/vis2k73562/hlapi-community-edition/Mirror.svg)](https://ci.appveyor.com/project/vis2k73562/hlapi-community-edition/branch/mirror)
@ -24,9 +24,9 @@ What previously required **10.000** lines of code, now takes **1.000** lines of
_Note: Mirror is based on Unity's abandoned UNET Networking system. We fixed it up and pushed it to MMO Scale._
## Documentation
Check out our [Documentation](https://mirror-networking.com/xmldocs/).
Check out our [Documentation](https://mirror-networking.com/docs/).
If you are migrating from UNET, then please check out our [Migration Guide](https://mirror-networking.com/xmldocs/General/Migration.html). Don't panic, it's very easy and won't take more than 5 minutes.
If you are migrating from UNET, then please check out our [Migration Guide](https://mirror-networking.com/docs/General/Migration.html). Don't panic, it's very easy and won't take more than 5 minutes.
## Installation
We **recommend** to download the most **stable Mirror version** from the [Asset Store](https://assetstore.unity.com/packages/tools/network/mirror-129321)!

2
appveyor.yml
View File

@ -41,5 +41,5 @@ environment:
deploy_script:
- semantic-release
- IF "%APPVEYOR_REPO_BRANCH%"=="master" ( lftp -e 'set ftp:ssl-allow no ; mirror -R -c -e -p doc/_site public_html/xmldocs; chmod -R a+X public_html/xmldocs ; ls -l public_html/xmldocs/ ; ls -l public_html/xmldocs/styles/ ; bye' -u mirreofx --env-password ftp://mirror-networking.com 2>&1 )
- IF "%APPVEYOR_REPO_BRANCH%"=="master" ( lftp -e 'set ftp:ssl-allow no ; mirror -R -c -e -p doc/_site public_html/docs; chmod -R a+X public_html/docs ; ls -l public_html/docs/ ; ls -l public_html/docs/styles/ ; bye' -u mirreofx --env-password ftp://mirror-networking.com 2>&1 )

2
doc/toc.yml
View File

@ -5,7 +5,7 @@
- name: Components
href: Components/index.md
- name: API Reference
href: https://mirror-networking.com/xmldocs/api/Mirror.html
href: https://mirror-networking.com/docs/api/Mirror.html
- name: Transports
href: Transports/index.md
- name: Examples