From 16ee90adfd5a4990bf0d95057c0e80b9196ac4a6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Albin=20Cor=C3=A9n?= <2108U9@gmail.com> Date: Sat, 31 Mar 2018 10:19:37 +0200 Subject: [PATCH] Added class summaries --- Docs.shfbproj | 72 +++++++++++++++++++ MLAPI/Data/NetworkingConfiguration.cs | 3 + MLAPI/MLAPI.csproj | 3 + .../MonoBehaviours/Core/NetworkedBehaviour.cs | 3 + MLAPI/MonoBehaviours/Core/NetworkedObject.cs | 3 + .../MonoBehaviours/Core/NetworkingManager.cs | 3 + MLAPI/MonoBehaviours/Core/TrackedObject.cs | 4 ++ .../Prototyping/NetworkedAnimator.cs | 3 + .../Prototyping/NetworkedNavMeshAgent.cs | 3 + .../Prototyping/NetworkedTransform.cs | 3 + .../CryptographyHelper.cs | 3 + .../DiffieHellman.cs | 2 +- .../EllipticCurve.cs | 4 +- .../LagCompensationManager.cs | 3 + .../MessageChunker.cs | 3 + .../NetworkPoolManager.cs | 3 + .../NetworkSceneManager.cs | 3 + 17 files changed, 118 insertions(+), 3 deletions(-) create mode 100644 Docs.shfbproj diff --git a/Docs.shfbproj b/Docs.shfbproj new file mode 100644 index 0000000..bdc9f56 --- /dev/null +++ b/Docs.shfbproj @@ -0,0 +1,72 @@ + + + + + Debug + AnyCPU + 2.0 + {6bae2f52-652d-4268-923d-0e1198bdc825} + 2017.9.26.0 + + Documentation + Documentation + Documentation + + .NET Framework 3.5 + Docs\ + Documentation + en-US + Markdown + C# + Markdown + True + True + False + False + OnlyWarningsAndErrors + MLAPI API Reference + 1.0.0.0 + False + False + False + Blank + MemberName + AboveNamespaces + MLAPI\ + False + + + + Summary, Parameter, Returns, AutoDocumentCtors, TypeParameter, AutoDocumentDispose + + + + + + + + + + + + + + + + + + + + + + + + + + + OnBuildSuccess + + \ No newline at end of file diff --git a/MLAPI/Data/NetworkingConfiguration.cs b/MLAPI/Data/NetworkingConfiguration.cs index fd4fd15..a0d116c 100644 --- a/MLAPI/Data/NetworkingConfiguration.cs +++ b/MLAPI/Data/NetworkingConfiguration.cs @@ -6,6 +6,9 @@ using UnityEngine.Networking; namespace MLAPI { + /// + /// The configuration object used to start server, client and hosts + /// public class NetworkingConfiguration { /// diff --git a/MLAPI/MLAPI.csproj b/MLAPI/MLAPI.csproj index 853a623..99731c7 100644 --- a/MLAPI/MLAPI.csproj +++ b/MLAPI/MLAPI.csproj @@ -24,6 +24,7 @@ prompt 4 Auto + bin\Debug\MLAPI.xml pdbonly @@ -43,6 +44,8 @@ MinimumRecommendedRules.ruleset Auto false + + false diff --git a/MLAPI/MonoBehaviours/Core/NetworkedBehaviour.cs b/MLAPI/MonoBehaviours/Core/NetworkedBehaviour.cs index e0c199f..be5041a 100644 --- a/MLAPI/MonoBehaviours/Core/NetworkedBehaviour.cs +++ b/MLAPI/MonoBehaviours/Core/NetworkedBehaviour.cs @@ -10,6 +10,9 @@ using MLAPI.Data; namespace MLAPI { + /// + /// The base class to override to write networked code. Inherits MonoBehaviour + /// public abstract class NetworkedBehaviour : MonoBehaviour { /// diff --git a/MLAPI/MonoBehaviours/Core/NetworkedObject.cs b/MLAPI/MonoBehaviours/Core/NetworkedObject.cs index d258662..fed016d 100644 --- a/MLAPI/MonoBehaviours/Core/NetworkedObject.cs +++ b/MLAPI/MonoBehaviours/Core/NetworkedObject.cs @@ -5,6 +5,9 @@ using UnityEngine; namespace MLAPI { + /// + /// A component used to identify that a GameObject is networked + /// [AddComponentMenu("MLAPI/NetworkedObject", -99)] public class NetworkedObject : MonoBehaviour { diff --git a/MLAPI/MonoBehaviours/Core/NetworkingManager.cs b/MLAPI/MonoBehaviours/Core/NetworkingManager.cs index 89b1848..b7d788e 100644 --- a/MLAPI/MonoBehaviours/Core/NetworkingManager.cs +++ b/MLAPI/MonoBehaviours/Core/NetworkingManager.cs @@ -11,6 +11,9 @@ using System.Security.Cryptography; namespace MLAPI { + /// + /// The main component of the library + /// [AddComponentMenu("MLAPI/NetworkingManager", -100)] public class NetworkingManager : MonoBehaviour { diff --git a/MLAPI/MonoBehaviours/Core/TrackedObject.cs b/MLAPI/MonoBehaviours/Core/TrackedObject.cs index 8d06eb7..b1a28f7 100644 --- a/MLAPI/MonoBehaviours/Core/TrackedObject.cs +++ b/MLAPI/MonoBehaviours/Core/TrackedObject.cs @@ -7,6 +7,10 @@ namespace MLAPI.MonoBehaviours.Core { //Based on: https://twotenpvp.github.io/lag-compensation-in-unity.html //Modified to be used with latency rather than fixed frames and subframes. Thus it will be less accrurate but more modular. + + /// + /// A component used for lag compensation. Each object with this component will get tracked + /// [AddComponentMenu("MLAPI/TrackedObject", -98)] public class TrackedObject : MonoBehaviour { diff --git a/MLAPI/MonoBehaviours/Prototyping/NetworkedAnimator.cs b/MLAPI/MonoBehaviours/Prototyping/NetworkedAnimator.cs index 1171335..a7270ec 100644 --- a/MLAPI/MonoBehaviours/Prototyping/NetworkedAnimator.cs +++ b/MLAPI/MonoBehaviours/Prototyping/NetworkedAnimator.cs @@ -4,6 +4,9 @@ using UnityEngine; namespace MLAPI.MonoBehaviours.Prototyping { + /// + /// A prototype component for syncing animations + /// [AddComponentMenu("MLAPI/NetworkedAnimator")] public class NetworkedAnimator : NetworkedBehaviour { diff --git a/MLAPI/MonoBehaviours/Prototyping/NetworkedNavMeshAgent.cs b/MLAPI/MonoBehaviours/Prototyping/NetworkedNavMeshAgent.cs index 0a22644..64825cd 100644 --- a/MLAPI/MonoBehaviours/Prototyping/NetworkedNavMeshAgent.cs +++ b/MLAPI/MonoBehaviours/Prototyping/NetworkedNavMeshAgent.cs @@ -5,6 +5,9 @@ using UnityEngine.AI; namespace MLAPI.MonoBehaviours.Prototyping { + /// + /// A prototype component for syncing navmeshagents + /// [AddComponentMenu("MLAPI/NetworkedNavMeshAgent")] public class NetworkedNavMeshAgent : NetworkedBehaviour { diff --git a/MLAPI/MonoBehaviours/Prototyping/NetworkedTransform.cs b/MLAPI/MonoBehaviours/Prototyping/NetworkedTransform.cs index c3d29cc..9e6f6ea 100644 --- a/MLAPI/MonoBehaviours/Prototyping/NetworkedTransform.cs +++ b/MLAPI/MonoBehaviours/Prototyping/NetworkedTransform.cs @@ -3,6 +3,9 @@ using UnityEngine; namespace MLAPI.MonoBehaviours.Prototyping { + /// + /// A prototype component for syncing transforms + /// [AddComponentMenu("MLAPI/NetworkedTransform")] public class NetworkedTransform : NetworkedBehaviour { diff --git a/MLAPI/NetworkingManagerComponents/CryptographyHelper.cs b/MLAPI/NetworkingManagerComponents/CryptographyHelper.cs index 126f418..b6b1ed6 100644 --- a/MLAPI/NetworkingManagerComponents/CryptographyHelper.cs +++ b/MLAPI/NetworkingManagerComponents/CryptographyHelper.cs @@ -4,6 +4,9 @@ using System.IO; namespace MLAPI.NetworkingManagerComponents { + /// + /// Helper class for encryption purposes + /// public static class CryptographyHelper { /// diff --git a/MLAPI/NetworkingManagerComponents/DiffieHellman.cs b/MLAPI/NetworkingManagerComponents/DiffieHellman.cs index 4915ddf..5996ae1 100644 --- a/MLAPI/NetworkingManagerComponents/DiffieHellman.cs +++ b/MLAPI/NetworkingManagerComponents/DiffieHellman.cs @@ -5,7 +5,7 @@ using System.Security.Cryptography; namespace MLAPI.NetworkingManagerComponents { - public class EllipticDiffieHellman + internal class EllipticDiffieHellman { protected static readonly RNGCryptoServiceProvider rand = new RNGCryptoServiceProvider(); public static readonly IntX DEFAULT_PRIME = (new IntX(1) << 255) - 19; diff --git a/MLAPI/NetworkingManagerComponents/EllipticCurve.cs b/MLAPI/NetworkingManagerComponents/EllipticCurve.cs index 3be71c8..51ab1fd 100644 --- a/MLAPI/NetworkingManagerComponents/EllipticCurve.cs +++ b/MLAPI/NetworkingManagerComponents/EllipticCurve.cs @@ -4,7 +4,7 @@ using IntXLib; namespace MLAPI.NetworkingManagerComponents { - public class CurvePoint + internal class CurvePoint { public static readonly CurvePoint POINT_AT_INFINITY = new CurvePoint(); public IntX X { get; private set; } @@ -22,7 +22,7 @@ namespace MLAPI.NetworkingManagerComponents } } - public class EllipticCurve + internal class EllipticCurve { public enum CurveType { Weierstrass, Montgomery } diff --git a/MLAPI/NetworkingManagerComponents/LagCompensationManager.cs b/MLAPI/NetworkingManagerComponents/LagCompensationManager.cs index 41e9d51..55286c0 100644 --- a/MLAPI/NetworkingManagerComponents/LagCompensationManager.cs +++ b/MLAPI/NetworkingManagerComponents/LagCompensationManager.cs @@ -6,6 +6,9 @@ using UnityEngine.Networking; namespace MLAPI.NetworkingManagerComponents { + /// + /// The main class for controlling lag compensation + /// public static class LagCompensationManager { public static List SimulationObjects = new List(); diff --git a/MLAPI/NetworkingManagerComponents/MessageChunker.cs b/MLAPI/NetworkingManagerComponents/MessageChunker.cs index 8df47e6..624d799 100644 --- a/MLAPI/NetworkingManagerComponents/MessageChunker.cs +++ b/MLAPI/NetworkingManagerComponents/MessageChunker.cs @@ -3,6 +3,9 @@ using System.Collections.Generic; namespace MLAPI.NetworkingManagerComponents { + /// + /// Helper class to chunk messages + /// public static class MessageChunker { /// diff --git a/MLAPI/NetworkingManagerComponents/NetworkPoolManager.cs b/MLAPI/NetworkingManagerComponents/NetworkPoolManager.cs index b9eb3bb..44c32f0 100644 --- a/MLAPI/NetworkingManagerComponents/NetworkPoolManager.cs +++ b/MLAPI/NetworkingManagerComponents/NetworkPoolManager.cs @@ -5,6 +5,9 @@ using UnityEngine; namespace MLAPI.NetworkingManagerComponents { + /// + /// Main class for managing network pools + /// public static class NetworkPoolManager { internal static Dictionary Pools; diff --git a/MLAPI/NetworkingManagerComponents/NetworkSceneManager.cs b/MLAPI/NetworkingManagerComponents/NetworkSceneManager.cs index a61f0b9..72c34cf 100644 --- a/MLAPI/NetworkingManagerComponents/NetworkSceneManager.cs +++ b/MLAPI/NetworkingManagerComponents/NetworkSceneManager.cs @@ -6,6 +6,9 @@ using UnityEngine.SceneManagement; namespace MLAPI.NetworkingManagerComponents { + /// + /// Main class for managing network scenes + /// public static class NetworkSceneManager { internal static HashSet registeredSceneNames;