Added class summaries

TwoTenPvP · TwoTenPvP · commit 16ee90adfd5a · 2018-03-31T10:19:37.000+02:00
diff --git a/Docs.shfbproj b/Docs.shfbproj
@@ -0,0 +1,72 @@
+﻿<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="14.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup>
+    <!-- The configuration and platform will be used to determine which assemblies to include from solution and
+				 project documentation sources -->
+    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
+    <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
+    <SchemaVersion>2.0</SchemaVersion>
+    <ProjectGuid>{6bae2f52-652d-4268-923d-0e1198bdc825}</ProjectGuid>
+    <SHFBSchemaVersion>2017.9.26.0</SHFBSchemaVersion>
+    <!-- AssemblyName, Name, and RootNamespace are not used by SHFB but Visual Studio adds them anyway -->
+    <AssemblyName>Documentation</AssemblyName>
+    <RootNamespace>Documentation</RootNamespace>
+    <Name>Documentation</Name>
+    <!-- SHFB properties -->
+    <FrameworkVersion>.NET Framework 3.5</FrameworkVersion>
+    <OutputPath>Docs\</OutputPath>
+    <HtmlHelpName>Documentation</HtmlHelpName>
+    <Language>en-US</Language>
+    <HelpFileFormat>Markdown</HelpFileFormat>
+    <SyntaxFilters>C#</SyntaxFilters>
+    <PresentationStyle>Markdown</PresentationStyle>
+    <CleanIntermediates>True</CleanIntermediates>
+    <KeepLogFile>True</KeepLogFile>
+    <DisableCodeBlockComponent>False</DisableCodeBlockComponent>
+    <IndentHtml>False</IndentHtml>
+    <BuildAssemblerVerbosity>OnlyWarningsAndErrors</BuildAssemblerVerbosity>
+    <HelpTitle>MLAPI API Reference</HelpTitle>
+    <HelpFileVersion>1.0.0.0</HelpFileVersion>
+    <RootNamespaceContainer>False</RootNamespaceContainer>
+    <NamespaceGrouping>False</NamespaceGrouping>
+    <Preliminary>False</Preliminary>
+    <SdkLinkTarget>Blank</SdkLinkTarget>
+    <NamingMethod>MemberName</NamingMethod>
+    <ContentPlacement>AboveNamespaces</ContentPlacement>
+    <SourceCodeBasePath>MLAPI\</SourceCodeBasePath>
+    <WarnOnMissingSourceContext>False</WarnOnMissingSourceContext>
+    <DocumentationSources>
+      <DocumentationSource sourceFile="MLAPI\bin\Debug\MLAPI.dll" />
+<DocumentationSource sourceFile="MLAPI\bin\Debug\MLAPI.xml" /></DocumentationSources>
+    <MissingTags>Summary, Parameter, Returns, AutoDocumentCtors, TypeParameter, AutoDocumentDispose</MissingTags>
+  </PropertyGroup>
+  <!-- There are no properties for these groups.  AnyCPU needs to appear in order for Visual Studio to perform
+			 the build.  The others are optional common platform types that may appear. -->
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' ">
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x64' ">
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x64' ">
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|Win32' ">
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|Win32' ">
+  </PropertyGroup>
+  <!-- Import the SHFB build targets -->
+  <Import Project="$(SHFBROOT)\SandcastleHelpFileBuilder.targets" />
+  <!-- The pre-build and post-build event properties must appear *after* the targets file import in order to be
+			 evaluated correctly. -->
+  <PropertyGroup>
+    <PreBuildEvent>
+    </PreBuildEvent>
+    <PostBuildEvent>
+    </PostBuildEvent>
+    <RunPostBuildEvent>OnBuildSuccess</RunPostBuildEvent>
+  </PropertyGroup>
+</Project>
diff --git a/MLAPI/Data/NetworkingConfiguration.cs b/MLAPI/Data/NetworkingConfiguration.cs
@@ -6,6 +6,9 @@
 
 namespace MLAPI
 {
+    /// <summary>
+    /// The configuration object used to start server, client and hosts
+    /// </summary>
     public class NetworkingConfiguration
     {
         /// <summary>
diff --git a/MLAPI/MLAPI.csproj b/MLAPI/MLAPI.csproj
@@ -24,6 +24,7 @@
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
     <GenerateSerializationAssemblies>Auto</GenerateSerializationAssemblies>
+    <DocumentationFile>bin\Debug\MLAPI.xml</DocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
     <DebugType>pdbonly</DebugType>
@@ -43,6 +44,8 @@
     <CodeAnalysisRuleSet>MinimumRecommendedRules.ruleset</CodeAnalysisRuleSet>
     <GenerateSerializationAssemblies>Auto</GenerateSerializationAssemblies>
     <RunCodeAnalysis>false</RunCodeAnalysis>
+    <DocumentationFile>
+    </DocumentationFile>
   </PropertyGroup>
   <PropertyGroup>
     <SignAssembly>false</SignAssembly>
diff --git a/MLAPI/MonoBehaviours/Core/NetworkedBehaviour.cs b/MLAPI/MonoBehaviours/Core/NetworkedBehaviour.cs
@@ -10,6 +10,9 @@
 
 namespace MLAPI
 {
+    /// <summary>
+    /// The base class to override to write networked code. Inherits MonoBehaviour
+    /// </summary>
     public abstract class NetworkedBehaviour : MonoBehaviour
     {
         /// <summary>
diff --git a/MLAPI/MonoBehaviours/Core/NetworkedObject.cs b/MLAPI/MonoBehaviours/Core/NetworkedObject.cs
@@ -5,6 +5,9 @@
 
 namespace MLAPI
 {
+    /// <summary>
+    /// A component used to identify that a GameObject is networked
+    /// </summary>
     [AddComponentMenu("MLAPI/NetworkedObject", -99)]
     public class NetworkedObject : MonoBehaviour
     {
diff --git a/MLAPI/MonoBehaviours/Core/NetworkingManager.cs b/MLAPI/MonoBehaviours/Core/NetworkingManager.cs
@@ -11,6 +11,9 @@
 
 namespace MLAPI
 {
+    /// <summary>
+    /// The main component of the library
+    /// </summary>
     [AddComponentMenu("MLAPI/NetworkingManager", -100)]
     public class NetworkingManager : MonoBehaviour
     {
diff --git 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.
+
+    /// <summary>
+    /// A component used for lag compensation. Each object with this component will get tracked
+    /// </summary>
     [AddComponentMenu("MLAPI/TrackedObject", -98)]
     public class TrackedObject : MonoBehaviour
     {
diff --git a/MLAPI/MonoBehaviours/Prototyping/NetworkedAnimator.cs b/MLAPI/MonoBehaviours/Prototyping/NetworkedAnimator.cs
@@ -4,6 +4,9 @@
 
 namespace MLAPI.MonoBehaviours.Prototyping
 {
+    /// <summary>
+    /// A prototype component for syncing animations
+    /// </summary>
     [AddComponentMenu("MLAPI/NetworkedAnimator")]
     public class NetworkedAnimator : NetworkedBehaviour
     {
diff --git a/MLAPI/MonoBehaviours/Prototyping/NetworkedNavMeshAgent.cs b/MLAPI/MonoBehaviours/Prototyping/NetworkedNavMeshAgent.cs
@@ -5,6 +5,9 @@
 
 namespace MLAPI.MonoBehaviours.Prototyping
 {
+    /// <summary>
+    /// A prototype component for syncing navmeshagents
+    /// </summary>
     [AddComponentMenu("MLAPI/NetworkedNavMeshAgent")]
     public class NetworkedNavMeshAgent : NetworkedBehaviour
     {
diff --git a/MLAPI/MonoBehaviours/Prototyping/NetworkedTransform.cs b/MLAPI/MonoBehaviours/Prototyping/NetworkedTransform.cs
@@ -3,6 +3,9 @@
 
 namespace MLAPI.MonoBehaviours.Prototyping
 {
+    /// <summary>
+    /// A prototype component for syncing transforms
+    /// </summary>
     [AddComponentMenu("MLAPI/NetworkedTransform")]
     public class NetworkedTransform : NetworkedBehaviour
     {
diff --git a/MLAPI/NetworkingManagerComponents/CryptographyHelper.cs b/MLAPI/NetworkingManagerComponents/CryptographyHelper.cs
@@ -4,6 +4,9 @@
 
 namespace MLAPI.NetworkingManagerComponents
 {
+    /// <summary>
+    /// Helper class for encryption purposes
+    /// </summary>
     public static class CryptographyHelper
     {
         /// <summary>
diff --git a/MLAPI/NetworkingManagerComponents/DiffieHellman.cs b/MLAPI/NetworkingManagerComponents/DiffieHellman.cs
@@ -5,7 +5,7 @@
 
 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
@@ -4,7 +4,7 @@
 
 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 @@ public override string ToString()
         }
     }
 
-    public class EllipticCurve
+    internal class EllipticCurve
     {
         public enum CurveType { Weierstrass, Montgomery }
 
diff --git a/MLAPI/NetworkingManagerComponents/LagCompensationManager.cs b/MLAPI/NetworkingManagerComponents/LagCompensationManager.cs
@@ -6,6 +6,9 @@
 
 namespace MLAPI.NetworkingManagerComponents
 {
+    /// <summary>
+    /// The main class for controlling lag compensation
+    /// </summary>
     public static class LagCompensationManager
     {
         public static List<TrackedObject> SimulationObjects = new List<TrackedObject>();
diff --git a/MLAPI/NetworkingManagerComponents/MessageChunker.cs b/MLAPI/NetworkingManagerComponents/MessageChunker.cs
@@ -3,6 +3,9 @@
 
 namespace MLAPI.NetworkingManagerComponents
 {
+    /// <summary>
+    /// Helper class to chunk messages
+    /// </summary>
     public static class MessageChunker
     {
         /// <summary>
diff --git a/MLAPI/NetworkingManagerComponents/NetworkPoolManager.cs b/MLAPI/NetworkingManagerComponents/NetworkPoolManager.cs
@@ -5,6 +5,9 @@
 
 namespace MLAPI.NetworkingManagerComponents
 {
+    /// <summary>
+    /// Main class for managing network pools
+    /// </summary>
     public static class NetworkPoolManager
     {
         internal static Dictionary<ushort, NetworkPool> Pools;
diff --git a/MLAPI/NetworkingManagerComponents/NetworkSceneManager.cs b/MLAPI/NetworkingManagerComponents/NetworkSceneManager.cs
@@ -6,6 +6,9 @@
 
 namespace MLAPI.NetworkingManagerComponents
 {
+    /// <summary>
+    /// Main class for managing network scenes
+    /// </summary>
     public static class NetworkSceneManager
     {
         internal static HashSet<string> registeredSceneNames;

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,9 @@`
`6`	`6`
`7`	`7`	`namespace MLAPI`
`8`	`8`	`{`
	`9`	`+ /// <summary>`
	`10`	`+ /// The configuration object used to start server, client and hosts`
	`11`	`+ /// </summary>`
`9`	`12`	`public class NetworkingConfiguration`
`10`	`13`	`{`
`11`	`14`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,9 @@`
`10`	`10`
`11`	`11`	`namespace MLAPI`
`12`	`12`	`{`
	`13`	`+ /// <summary>`
	`14`	`+ /// The base class to override to write networked code. Inherits MonoBehaviour`
	`15`	`+ /// </summary>`
`13`	`16`	`public abstract class NetworkedBehaviour : MonoBehaviour`
`14`	`17`	`{`
`15`	`18`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,9 @@`
`5`	`5`
`6`	`6`	`namespace MLAPI`
`7`	`7`	`{`
	`8`	`+ /// <summary>`
	`9`	`+ /// A component used to identify that a GameObject is networked`
	`10`	`+ /// </summary>`
`8`	`11`	`[AddComponentMenu("MLAPI/NetworkedObject", -99)]`
`9`	`12`	`public class NetworkedObject : MonoBehaviour`
`10`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,9 @@`
`11`	`11`
`12`	`12`	`namespace MLAPI`
`13`	`13`	`{`
	`14`	`+ /// <summary>`
	`15`	`+ /// The main component of the library`
	`16`	`+ /// </summary>`
`14`	`17`	`[AddComponentMenu("MLAPI/NetworkingManager", -100)]`
`15`	`18`	`public class NetworkingManager : MonoBehaviour`
`16`	`19`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,10 @@ namespace MLAPI.MonoBehaviours.Core`
`7`	`7`	`{`
`8`	`8`	`//Based on: https://twotenpvp.github.io/lag-compensation-in-unity.html`
`9`	`9`	`//Modified to be used with latency rather than fixed frames and subframes. Thus it will be less accrurate but more modular.`
	`10`	`+`
	`11`	`+ /// <summary>`
	`12`	`+ /// A component used for lag compensation. Each object with this component will get tracked`
	`13`	`+ /// </summary>`
`10`	`14`	`[AddComponentMenu("MLAPI/TrackedObject", -98)]`
`11`	`15`	`public class TrackedObject : MonoBehaviour`
`12`	`16`	`{`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,9 @@`
`4`	`4`
`5`	`5`	`namespace MLAPI.MonoBehaviours.Prototyping`
`6`	`6`	`{`
	`7`	`+ /// <summary>`
	`8`	`+ /// A prototype component for syncing animations`
	`9`	`+ /// </summary>`
`7`	`10`	`[AddComponentMenu("MLAPI/NetworkedAnimator")]`
`8`	`11`	`public class NetworkedAnimator : NetworkedBehaviour`
`9`	`12`	`{`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,9 @@`
`3`	`3`
`4`	`4`	`namespace MLAPI.MonoBehaviours.Prototyping`
`5`	`5`	`{`
	`6`	`+ /// <summary>`
	`7`	`+ /// A prototype component for syncing transforms`
	`8`	`+ /// </summary>`
`6`	`9`	`[AddComponentMenu("MLAPI/NetworkedTransform")]`
`7`	`10`	`public class NetworkedTransform : NetworkedBehaviour`
`8`	`11`	`{`