chore(Utilities): re-number documentation headers

thestonefox · thestonefox · commit 5d73db28b78d · 2017-09-03T15:17:02.000+01:00
The header comment for the Utilities scripts have been re-numbered
so they are in better block units.

The Nav Mesh Data script has also had the documentation generated
for it.
diff --git a/Assets/VRTK/Documentation/API.md b/Assets/VRTK/Documentation/API.md
@@ -6523,6 +6523,7 @@ A collection of scripts that provide useful functionality to aid the creation pr
  * [Shared Methods](#shared-methods-vrtk_sharedmethods)
  * [Policy List](#policy-list-vrtk_policylist)
  * [Custom Raycast](#custom-raycast-vrtk_customraycast)
+ * [Nav Mesh Data](#nav-mesh-data-vrtk_navmeshdata)
  * [Adaptive Quality](#adaptive-quality-vrtk_adaptivequality)
  * [Object Follow](#object-follow-vrtk_objectfollow)
  * [Rigidbody Follow](#rigidbody-follow-vrtk_rigidbodyfollow)
@@ -7518,6 +7519,19 @@ The CustomCapsuleCast method is used to generate a capsulecast based on the opti
 
 ---
 
+## Nav Mesh Data (VRTK_NavMeshData)
+
+### Overview
+
+The Nav Mesh Data script allows custom nav mesh information to be provided to the teleporter script.
+
+### Inspector Parameters
+
+ * **Distance Limit:** The max distance given point can be outside the nav mesh to be considered valid.
+ * **Valid Areas:** The parts of the navmesh that are considered valid
+
+---
+
 ## Adaptive Quality (VRTK_AdaptiveQuality)
 
 ### Overview
diff --git a/Assets/VRTK/Source/Scripts/Utilities/ObjectFollow/VRTK_ObjectFollow.cs b/Assets/VRTK/Source/Scripts/Utilities/ObjectFollow/VRTK_ObjectFollow.cs
@@ -1,4 +1,4 @@
-﻿// Object Follow|Utilities|90060
+﻿// Object Follow|Utilities|90110
 namespace VRTK
 {
     using UnityEngine;
diff --git a/Assets/VRTK/Source/Scripts/Utilities/ObjectFollow/VRTK_RigidbodyFollow.cs b/Assets/VRTK/Source/Scripts/Utilities/ObjectFollow/VRTK_RigidbodyFollow.cs
@@ -1,4 +1,4 @@
-﻿// Rigidbody Follow|Utilities|90061
+﻿// Rigidbody Follow|Utilities|90120
 namespace VRTK
 {
     using UnityEngine;
diff --git a/Assets/VRTK/Source/Scripts/Utilities/ObjectFollow/VRTK_TransformFollow.cs b/Assets/VRTK/Source/Scripts/Utilities/ObjectFollow/VRTK_TransformFollow.cs
@@ -1,4 +1,4 @@
-﻿// Transform Follow|Utilities|90062
+﻿// Transform Follow|Utilities|90130
 namespace VRTK
 {
     using UnityEngine;
diff --git a/Assets/VRTK/Source/Scripts/Utilities/SDK/VRTK_SDKInfo.cs b/Assets/VRTK/Source/Scripts/Utilities/SDK/VRTK_SDKInfo.cs
@@ -1,10 +1,9 @@
-﻿// SDK Info|Utilities|90013
+﻿// SDK Info|Utilities|90040
 namespace VRTK
 {
     using UnityEngine;
     using System;
     using System.Collections.Generic;
-    using System.Linq;
 
     /// <summary>
     /// Holds all the info necessary to describe an SDK.
diff --git a/Assets/VRTK/Source/Scripts/Utilities/SDK/VRTK_SDKSetup.cs b/Assets/VRTK/Source/Scripts/Utilities/SDK/VRTK_SDKSetup.cs
@@ -1,4 +1,4 @@
-﻿// SDK Setup|Utilities|90012
+﻿// SDK Setup|Utilities|90030
 namespace VRTK
 {
     using UnityEngine;
diff --git a/Assets/VRTK/Source/Scripts/Utilities/SDK/VRTK_SDKSetupSwitcher.cs b/Assets/VRTK/Source/Scripts/Utilities/SDK/VRTK_SDKSetupSwitcher.cs
@@ -1,4 +1,4 @@
-﻿// SDK Setup Switcher|Utilities|90011
+﻿// SDK Setup Switcher|Utilities|90020
 namespace VRTK
 {
     using UnityEngine;
diff --git a/Assets/VRTK/Source/Scripts/Utilities/VRTK_AdaptiveQuality.cs b/Assets/VRTK/Source/Scripts/Utilities/VRTK_AdaptiveQuality.cs
@@ -1,4 +1,4 @@
-// Adaptive Quality|Utilities|90050
+// Adaptive Quality|Utilities|90100
 
 // Adapted from The Lab Renderer's ValveCamera.cs, available at
 // https://github.com/ValveSoftware/the_lab_renderer/blob/ae64c48a8ccbe5406aba1e39b160d4f2f7156c2c/Assets/TheLabRenderer/Scripts/ValveCamera.cs
diff --git a/Assets/VRTK/Source/Scripts/Utilities/VRTK_CustomRaycast.cs b/Assets/VRTK/Source/Scripts/Utilities/VRTK_CustomRaycast.cs
@@ -1,4 +1,4 @@
-﻿// Custom Raycast|Utilities|90045
+﻿// Custom Raycast|Utilities|90080
 namespace VRTK
 {
     using UnityEngine;
diff --git a/Assets/VRTK/Source/Scripts/Utilities/VRTK_DeviceFinder.cs b/Assets/VRTK/Source/Scripts/Utilities/VRTK_DeviceFinder.cs
@@ -1,4 +1,4 @@
-﻿// Device Finder|Utilities|90020
+﻿// Device Finder|Utilities|90050
 namespace VRTK
 {
     using UnityEngine;
diff --git a/Assets/VRTK/Source/Scripts/Utilities/VRTK_NavMeshData.cs b/Assets/VRTK/Source/Scripts/Utilities/VRTK_NavMeshData.cs
@@ -1,7 +1,11 @@
-﻿namespace VRTK
+﻿// Nav Mesh Data|Utilities|90090
+namespace VRTK
 {
     using UnityEngine;
 
+    /// <summary>
+    /// The Nav Mesh Data script allows custom nav mesh information to be provided to the teleporter script.
+    /// </summary>
     public class VRTK_NavMeshData : MonoBehaviour
     {
         [Tooltip("The max distance given point can be outside the nav mesh to be considered valid.")]
diff --git a/Assets/VRTK/Source/Scripts/Utilities/VRTK_PolicyList.cs b/Assets/VRTK/Source/Scripts/Utilities/VRTK_PolicyList.cs
@@ -1,4 +1,4 @@
-﻿// Policy List|Utilities|90040
+﻿// Policy List|Utilities|90070
 namespace VRTK
 {
     using UnityEngine;
diff --git a/Assets/VRTK/Source/Scripts/Utilities/VRTK_SDKObjectAlias.cs b/Assets/VRTK/Source/Scripts/Utilities/VRTK_SDKObjectAlias.cs
@@ -1,4 +1,4 @@
-﻿// SDK Object Alias|Utilities|90063
+﻿// SDK Object Alias|Utilities|90140
 namespace VRTK
 {
     using UnityEngine;
diff --git a/Assets/VRTK/Source/Scripts/Utilities/VRTK_SDKTransformModify.cs b/Assets/VRTK/Source/Scripts/Utilities/VRTK_SDKTransformModify.cs
@@ -1,4 +1,4 @@
-﻿// SDK Transform Modify|Utilities|90064
+﻿// SDK Transform Modify|Utilities|90150
 namespace VRTK
 {
     using UnityEngine;
diff --git a/Assets/VRTK/Source/Scripts/Utilities/VRTK_SharedMethods.cs b/Assets/VRTK/Source/Scripts/Utilities/VRTK_SharedMethods.cs
@@ -1,4 +1,4 @@
-﻿// Shared Methods|Utilities|90030
+﻿// Shared Methods|Utilities|90060
 namespace VRTK
 {
     using UnityEngine;
diff --git a/Assets/VRTK/Source/Scripts/Utilities/VRTK_Simulator.cs b/Assets/VRTK/Source/Scripts/Utilities/VRTK_Simulator.cs
@@ -1,4 +1,4 @@
-﻿// Simulating Headset Movement|Utilities|90070
+﻿// Simulating Headset Movement|Utilities|90170
 namespace VRTK
 {
     using UnityEngine;
diff --git a/Assets/VRTK/Source/Scripts/Utilities/VRTK_VelocityEstimator.cs b/Assets/VRTK/Source/Scripts/Utilities/VRTK_VelocityEstimator.cs
@@ -1,4 +1,4 @@
-﻿// Velocity Estimator|Utilities|90080
+﻿// Velocity Estimator|Utilities|90180
 namespace VRTK
 {
     using UnityEngine;

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Object Follow\|Utilities\|90060`
	`1`	`+// Object Follow\|Utilities\|90110`
`2`	`2`	`namespace VRTK`
`3`	`3`	`{`
`4`	`4`	`using UnityEngine;`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Rigidbody Follow\|Utilities\|90061`
	`1`	`+// Rigidbody Follow\|Utilities\|90120`
`2`	`2`	`namespace VRTK`
`3`	`3`	`{`
`4`	`4`	`using UnityEngine;`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Transform Follow\|Utilities\|90062`
	`1`	`+// Transform Follow\|Utilities\|90130`
`2`	`2`	`namespace VRTK`
`3`	`3`	`{`
`4`	`4`	`using UnityEngine;`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// SDK Setup\|Utilities\|90012`
	`1`	`+// SDK Setup\|Utilities\|90030`
`2`	`2`	`namespace VRTK`
`3`	`3`	`{`
`4`	`4`	`using UnityEngine;`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// SDK Setup Switcher\|Utilities\|90011`
	`1`	`+// SDK Setup Switcher\|Utilities\|90020`
`2`	`2`	`namespace VRTK`
`3`	`3`	`{`
`4`	`4`	`using UnityEngine;`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Adaptive Quality\|Utilities\|90050`
	`1`	`+// Adaptive Quality\|Utilities\|90100`
`2`	`2`
`3`	`3`	`// Adapted from The Lab Renderer's ValveCamera.cs, available at`
`4`	`4`	`// https://github.com/ValveSoftware/the_lab_renderer/blob/ae64c48a8ccbe5406aba1e39b160d4f2f7156c2c/Assets/TheLabRenderer/Scripts/ValveCamera.cs`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Custom Raycast\|Utilities\|90045`
	`1`	`+// Custom Raycast\|Utilities\|90080`
`2`	`2`	`namespace VRTK`
`3`	`3`	`{`
`4`	`4`	`using UnityEngine;`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Device Finder\|Utilities\|90020`
	`1`	`+// Device Finder\|Utilities\|90050`
`2`	`2`	`namespace VRTK`
`3`	`3`	`{`
`4`	`4`	`using UnityEngine;`