From ea883f01706c8cedd158ffc19c8c2262a76b363b Mon Sep 17 00:00:00 2001 From: Matt Schoen Date: Wed, 23 Sep 2020 20:24:53 -0700 Subject: [PATCH] Fix documentation generation warnings; Make test types not public --- Documentation~/com.unity.labs.editorxr.md | 22 +++++-------------- Tests/Editor/EditorXRTestInitializer.cs | 2 +- .../Unit/Core/EditingContextManagerTests.cs | 2 +- .../MonoBehaviourExtensionsTests.cs | 2 +- .../TransformExtensionsTests.cs | 2 +- .../Unit/Utilities/EditorXRUtilsTests.cs | 2 +- .../Unit/Utilities/GradientPairTests.cs | 2 +- .../Unit/Utilities/MathUtilsExtTests.cs | 2 +- 8 files changed, 12 insertions(+), 24 deletions(-) diff --git a/Documentation~/com.unity.labs.editorxr.md b/Documentation~/com.unity.labs.editorxr.md index 71cf6768..8e3105eb 100644 --- a/Documentation~/com.unity.labs.editorxr.md +++ b/Documentation~/com.unity.labs.editorxr.md @@ -23,7 +23,7 @@ This version of EditorXR is compatible with the following versions of the Unity ## Known limitations -*_EditorXR version 0.4.10-preview includes the following known limitations:_* +*_EditorXR version 0.4.13-preview includes the following known limitations:_* * *_Undo/redo do not record all change history yet in the Radial Menu_* * *_Toggles from the main menu are not yet supported (snap, locomotion type, etc)._* * *_Other EditorXR menus and workspaces still draw above the Spatial Menu._* @@ -46,8 +46,6 @@ If you are new to EditorXR, or have a question after reading the documentation, * Join our [support forum](https://forum.unity.com/forums/editorxr.126/). * Follow us on [Twitter](http://www.twitter.com/unity3dlabs). - - # Using EditorXR To use EditorXR, go to ****Windows**** > ****EditorXR**** (or press Ctrl-E on your keyboard), then put on your headset. You might need to click the button ****Toggle Device View**** to have it show correctly in the headset. @@ -279,8 +277,6 @@ To use EditorXR, go to ****Windows**** > ****EditorXR**** (or press Ctrl-E on yo [![Locked Objects](images/locked.png)](https://drive.google.com/open?id=1JgfadHWtL9mwIJ0I_vc2wb2vUSV8tT9e "Locked Objects") - - # EditorXR workflows To create assets: @@ -317,21 +313,17 @@ To place assets: [![Place](images/placement.png)](https://drive.google.com/open?id=1Oxh5uYDp5MoxwKeaTjgT_d3GBpKUi5u6 "Place") - - # Advanced topics This section provides more information on the following topics: -* [EditorXR Runtime](#first): explains the use of EditorXR in Play Mode and included in Player builds. +* [EditorXR Runtime](#editorxr-runtime): explains the use of EditorXR in Play Mode and included in Player builds. -* [Minimal Context](#second): explains the origin of ... +* [Minimal Context](#minimal-context): explains the origin of ... -* [Image Effect and Camera Settings Copy Support](#third): explains the origin of ... +* [Image Effect and Camera Settings Copy Support](#image-effect-and-camera-settings-copy-support): explains the origin of ... -* [Extending EditorXR](#fourth): explains the origin of ... - - +* [Extending EditorXR](#extending-editorxr): explains the origin of ... ## EditorXR Runtime @@ -347,8 +339,6 @@ Before entering Play Mode or making a build, there is one final step: you must c This will add support for the Script Importer functionality which many EditorXR systems rely on. This collects all of the MonoBehaviours that are instantiated during an EditorXR session and creates prefabs out of them, which will include asset references that were set in the Script Importer inspector. If you have created any new EditorXR systems you may want to ensure that you update this asset as you make changes, or tag your classes with the interfaces used within the DefaultScriptReferences class. - - ## Minimal Context * Ideal for lightweight client builds not requiring much of the EditorXR UI @@ -359,8 +349,6 @@ Before entering Play Mode or making a build, there is one final step: you must c * Can be located in the project at : - Assets/EditorXR/Scripts/Core/Contexts/Minimal - - ## Image Effect & Camera Settings Copy Support EditorXR has limited support for automatic copying of (post)image effects to the EditorXR camera(s), from the MainCamera in your scene. This includes the in-HMD camera, and the “presentation camera”. Both cameras are created by EditorXR on startup of an EditorXR session. diff --git a/Tests/Editor/EditorXRTestInitializer.cs b/Tests/Editor/EditorXRTestInitializer.cs index 4b83af1a..82ab2423 100644 --- a/Tests/Editor/EditorXRTestInitializer.cs +++ b/Tests/Editor/EditorXRTestInitializer.cs @@ -10,7 +10,7 @@ using UnityEditor; namespace Unity.EditorXR.Tests.Core { [SetUpFixture] - public class EditorXRTestInitializer + class EditorXRTestInitializer { EditingContextManagerSettings projectSettingsBackup; EditingContextManagerSettings userSettingsBackup; diff --git a/Tests/Editor/Unit/Core/EditingContextManagerTests.cs b/Tests/Editor/Unit/Core/EditingContextManagerTests.cs index d888cf29..c0026057 100644 --- a/Tests/Editor/Unit/Core/EditingContextManagerTests.cs +++ b/Tests/Editor/Unit/Core/EditingContextManagerTests.cs @@ -16,7 +16,7 @@ using UnityEngine; namespace Unity.EditorXR.Tests.Core { [TestFixture] - public class EditingContextManagerTests + class EditingContextManagerTests { GameObject go; EditorXRContext context, context2; diff --git a/Tests/Editor/Unit/Extension Methods/MonoBehaviourExtensionsTests.cs b/Tests/Editor/Unit/Extension Methods/MonoBehaviourExtensionsTests.cs index 20dd79d8..9d8f4b8d 100644 --- a/Tests/Editor/Unit/Extension Methods/MonoBehaviourExtensionsTests.cs +++ b/Tests/Editor/Unit/Extension Methods/MonoBehaviourExtensionsTests.cs @@ -6,7 +6,7 @@ using Unity.EditorXR.Proxies; namespace Unity.EditorXR.Tests.Extensions { - public class MonoBehaviourExtensionsTests + class MonoBehaviourExtensionsTests { MonoBehaviour mb; int coIndex = 0; diff --git a/Tests/Editor/Unit/Extension Methods/TransformExtensionsTests.cs b/Tests/Editor/Unit/Extension Methods/TransformExtensionsTests.cs index bbb8a971..a4120800 100644 --- a/Tests/Editor/Unit/Extension Methods/TransformExtensionsTests.cs +++ b/Tests/Editor/Unit/Extension Methods/TransformExtensionsTests.cs @@ -5,7 +5,7 @@ using Unity.EditorXR.Extensions; namespace Unity.EditorXR.Tests.Extensions { [TestFixture] - public class TransformExtensionsTests + class TransformExtensionsTests { GameObject go; float delta = 0.00000001f; diff --git a/Tests/Editor/Unit/Utilities/EditorXRUtilsTests.cs b/Tests/Editor/Unit/Utilities/EditorXRUtilsTests.cs index b4e5a69f..1f6965cc 100644 --- a/Tests/Editor/Unit/Utilities/EditorXRUtilsTests.cs +++ b/Tests/Editor/Unit/Utilities/EditorXRUtilsTests.cs @@ -7,7 +7,7 @@ using UnityEngine; namespace Unity.EditorXR.Tests.Utilities { [TestFixture] - public class EditorXRUtilsTests + class EditorXRUtilsTests { GameObject m_GO, m_Parent, m_Other; List m_ToCleanupAfterEach = new List(); diff --git a/Tests/Editor/Unit/Utilities/GradientPairTests.cs b/Tests/Editor/Unit/Utilities/GradientPairTests.cs index 21098eda..f9124873 100644 --- a/Tests/Editor/Unit/Utilities/GradientPairTests.cs +++ b/Tests/Editor/Unit/Utilities/GradientPairTests.cs @@ -5,7 +5,7 @@ using UnityEngine; namespace Unity.EditorXR.Tests.Utilities { [TestFixture] - public class GradientPairTests + class GradientPairTests { Color m_ColorA; Color m_ColorB; diff --git a/Tests/Editor/Unit/Utilities/MathUtilsExtTests.cs b/Tests/Editor/Unit/Utilities/MathUtilsExtTests.cs index d71eadc4..b782db6c 100644 --- a/Tests/Editor/Unit/Utilities/MathUtilsExtTests.cs +++ b/Tests/Editor/Unit/Utilities/MathUtilsExtTests.cs @@ -5,7 +5,7 @@ using UnityEngine; namespace Unity.EditorXR.Tests.Utilities { [TestFixture] - public class MathUtilsExtTests + class MathUtilsExtTests { [OneTimeSetUp] public void Setup() { }