From 2adf13978490358f9ddac2065732c1f56b7d250f Mon Sep 17 00:00:00 2001 From: Adam Mollis Date: Mon, 12 Jun 2023 10:17:59 -0700 Subject: [PATCH 1/5] Fixing more summary comments. --- .../Subsystems/Speech/DictationSubsystem.cs | 2 +- .../InteractorVisuals/MRTKRayReticleVisual.cs | 13 +++++- .../Devices/ControllerSimulationSettings.cs | 11 ++++- .../SyntheticHands/SyntheticHandsConfig.cs | 5 +++ .../SyntheticHands/SyntheticHandsSubsystem.cs | 11 +++++ .../Constraints/FixedDistanceConstraint.cs | 10 +++-- .../FixedRotationToUserConstraint.cs | 8 +++- .../FixedRotationToWorldConstraint.cs | 8 +++- .../MaintainApparentSizeConstraint.cs | 8 +++- .../Constraints/MoveAxisConstraint.cs | 8 +++- .../Constraints/TransformConstraint.cs | 3 ++ .../Button/BasicPressableButtonVisuals.cs | 12 ++++-- .../Button/PressableButton.cs | 9 +++- .../Dialog/DialogEvents.cs | 11 ++--- .../Interop/CanvasProxyInteractor.cs | 9 +++- .../LegacyDialog/Dialog.cs | 11 ++++- .../LegacyDialog/DialogButtonTypes.cs | 42 ++++++++++++++++++- .../ObjectBar/ObjectBarFlowDirection.cs | 11 ++++- .../Toggle/ToggleCollection.cs | 18 ++++---- .../Toggle/ToggleSelectedEvent.cs | 5 +++ .../WindowsTextToSpeechSubsystem.cs | 12 ++++++ .../Subsystems/WindowsDictationSubsystem.cs | 12 ++++++ .../WindowsDictationSubsystemConfig.cs | 2 +- .../WindowsKeywordRecognitionSubsystem.cs | 13 ++++++ ...indowsKeywordRecognitionSubsystemConfig.cs | 2 +- 25 files changed, 214 insertions(+), 42 deletions(-) diff --git a/com.microsoft.mrtk.core/Subsystems/Speech/DictationSubsystem.cs b/com.microsoft.mrtk.core/Subsystems/Speech/DictationSubsystem.cs index 4c0063b3c44..65024ee9495 100644 --- a/com.microsoft.mrtk.core/Subsystems/Speech/DictationSubsystem.cs +++ b/com.microsoft.mrtk.core/Subsystems/Speech/DictationSubsystem.cs @@ -8,7 +8,7 @@ namespace Microsoft.MixedReality.Toolkit.Subsystems { /// - /// A subsystem that enables dictation. + /// A Unity subsystem that enables dictation. /// [Preserve] public class DictationSubsystem : diff --git a/com.microsoft.mrtk.input/Interactors/InteractorVisuals/MRTKRayReticleVisual.cs b/com.microsoft.mrtk.input/Interactors/InteractorVisuals/MRTKRayReticleVisual.cs index d29306357d1..8cba15a9f3c 100644 --- a/com.microsoft.mrtk.input/Interactors/InteractorVisuals/MRTKRayReticleVisual.cs +++ b/com.microsoft.mrtk.input/Interactors/InteractorVisuals/MRTKRayReticleVisual.cs @@ -36,7 +36,7 @@ public class MRTKRayReticleVisual : BaseReticleVisual private Vector3 reticleNormal; /// - /// Determines whether a reticle should appear on all surfaces hit by the interactor or interactables only + /// Determines whether a reticle should appear on all surfaces hit by the interactor or interactables only. /// public ReticleVisibilitySettings VisibilitySettings { @@ -173,9 +173,20 @@ private void LocateTargetHitPoint(SelectEnterEventArgs args) } } + /// + /// An enumeration used to control when a MRTKRayReticleVisual + /// is visible. + /// public enum ReticleVisibilitySettings { + /// + /// The reticle is only visible when it intersects an interactable object. + /// InteractablesOnly, + + /// + /// The reticle is visible anytime it intersects with another object, regardless of it being interactable. + /// AllValidSurfaces } } diff --git a/com.microsoft.mrtk.input/Simulation/Devices/ControllerSimulationSettings.cs b/com.microsoft.mrtk.input/Simulation/Devices/ControllerSimulationSettings.cs index 4347a479704..45f4b772eb5 100644 --- a/com.microsoft.mrtk.input/Simulation/Devices/ControllerSimulationSettings.cs +++ b/com.microsoft.mrtk.input/Simulation/Devices/ControllerSimulationSettings.cs @@ -52,9 +52,18 @@ public ControllerAnchorPoint AnchorPoint [Tooltip("The input action used to toggle between using the default or Secondary Handshape settings.")] private InputActionReference toggleSecondaryHandshapes; - [Obsolete("Use ChangeNeutralHandshape instead")] + /// + /// The input action used to toggle between using the default or Secondary Handshape settings. + /// + /// + /// This property is deprecated, use instead. + /// + [Obsolete("This property is deprecated, use ToggleSecondaryHandshapes instead.")] public InputActionReference ChangeNeutralPose => ToggleSecondaryHandshapes; + /// + /// The input action used to toggle between using the default or Secondary Handshape settings. + /// public InputActionReference ToggleSecondaryHandshapes { get => toggleSecondaryHandshapes; diff --git a/com.microsoft.mrtk.input/Subsystems/SyntheticHands/SyntheticHandsConfig.cs b/com.microsoft.mrtk.input/Subsystems/SyntheticHands/SyntheticHandsConfig.cs index 2a68b8ef1d1..bd134ba65a0 100644 --- a/com.microsoft.mrtk.input/Subsystems/SyntheticHands/SyntheticHandsConfig.cs +++ b/com.microsoft.mrtk.input/Subsystems/SyntheticHands/SyntheticHandsConfig.cs @@ -6,6 +6,11 @@ namespace Microsoft.MixedReality.Toolkit.Input { + /// + /// A configuration object for the SyntheticHandsSubsystem + /// class. This class defines the Unity input actions that SyntheticHandsSubsystem + /// uses when simulating articulated hands. + /// [CreateAssetMenu(fileName = "MRTKSyntheticHandsConfig.asset", menuName = "MRTK/Subsystems/MRTK Synthetic Hands Config")] public class SyntheticHandsConfig : BaseSubsystemConfig { diff --git a/com.microsoft.mrtk.input/Subsystems/SyntheticHands/SyntheticHandsSubsystem.cs b/com.microsoft.mrtk.input/Subsystems/SyntheticHands/SyntheticHandsSubsystem.cs index 5caf2fb250a..be0a71e39da 100644 --- a/com.microsoft.mrtk.input/Subsystems/SyntheticHands/SyntheticHandsSubsystem.cs +++ b/com.microsoft.mrtk.input/Subsystems/SyntheticHands/SyntheticHandsSubsystem.cs @@ -14,6 +14,9 @@ namespace Microsoft.MixedReality.Toolkit.Input { + /// + /// A Unity subsystem that enables articulated hand simulation. + /// [Preserve] [MRTKSubsystem( Name = "com.microsoft.mixedreality.synthhands", @@ -25,6 +28,10 @@ namespace Microsoft.MixedReality.Toolkit.Input public class SyntheticHandsSubsystem : HandsSubsystem { private SyntheticHandsProvider syntheticProvider; + + /// + /// Get the subsystem provider for this object. + /// private SyntheticHandsProvider SyntheticProvider { get @@ -392,6 +399,10 @@ private static void MirrorJoint(ref HandJointPose pose) } } + /// + /// A subsystem provider for that provides methods for getting and setting + /// the simulated hand poses, as well as methods for obtain hand joint poses. + /// [Preserve] class SyntheticHandsProvider : Provider { diff --git a/com.microsoft.mrtk.spatialmanipulation/Constraints/FixedDistanceConstraint.cs b/com.microsoft.mrtk.spatialmanipulation/Constraints/FixedDistanceConstraint.cs index 779a15cedfd..50fdabc4d3d 100644 --- a/com.microsoft.mrtk.spatialmanipulation/Constraints/FixedDistanceConstraint.cs +++ b/com.microsoft.mrtk.spatialmanipulation/Constraints/FixedDistanceConstraint.cs @@ -7,9 +7,12 @@ namespace Microsoft.MixedReality.Toolkit.SpatialManipulation { /// /// Component for setting the min/max scale values for ObjectManipulator - /// or BoundsControl - /// We're looking to rework this system in the future. These existing components will be deprecated then. + /// or BoundsControl. /// + /// + /// MRTK's constraint system might be redesigned in the near future. When + /// this occurs, the old constraint components will be deprecated. + /// public class FixedDistanceConstraint : TransformConstraint { #region Properties @@ -27,6 +30,7 @@ public Transform ConstraintTransform set => constraintTransform = value; } + /// public override TransformFlags ConstraintType => TransformFlags.Move; private float distanceAtManipulationStart; @@ -35,7 +39,7 @@ public Transform ConstraintTransform #region MonoBehaviour Methods - public void Start() + private void Start() { EnsureConstraintTransform(); } diff --git a/com.microsoft.mrtk.spatialmanipulation/Constraints/FixedRotationToUserConstraint.cs b/com.microsoft.mrtk.spatialmanipulation/Constraints/FixedRotationToUserConstraint.cs index 01707bb6771..a875282f298 100644 --- a/com.microsoft.mrtk.spatialmanipulation/Constraints/FixedRotationToUserConstraint.cs +++ b/com.microsoft.mrtk.spatialmanipulation/Constraints/FixedRotationToUserConstraint.cs @@ -6,13 +6,17 @@ namespace Microsoft.MixedReality.Toolkit.SpatialManipulation { /// - /// Component for fixing the rotation of a manipulated object relative to the user - /// We're looking to rework this system in the future. These existing components will be deprecated then. + /// Component for fixing the rotation of a manipulated object relative to the user. /// + /// + /// MRTK's constraint system might be redesigned in the near future. When + /// this occurs, the old constraint components will be deprecated. + /// public class FixedRotationToUserConstraint : TransformConstraint { #region Properties + /// public override TransformFlags ConstraintType => TransformFlags.Rotate; private Quaternion startObjectRotationCameraSpace; diff --git a/com.microsoft.mrtk.spatialmanipulation/Constraints/FixedRotationToWorldConstraint.cs b/com.microsoft.mrtk.spatialmanipulation/Constraints/FixedRotationToWorldConstraint.cs index d242c6cb17e..7d3ab125f63 100644 --- a/com.microsoft.mrtk.spatialmanipulation/Constraints/FixedRotationToWorldConstraint.cs +++ b/com.microsoft.mrtk.spatialmanipulation/Constraints/FixedRotationToWorldConstraint.cs @@ -4,13 +4,17 @@ namespace Microsoft.MixedReality.Toolkit.SpatialManipulation { /// - /// Component for fixing the rotation of a manipulated object relative to the world - /// We're looking to rework this system in the future. These existing components will be deprecated then. + /// Component for fixing the rotation of a manipulated object relative to the world. /// + /// + /// MRTK's constraint system might be redesigned in the near future. When + /// this occurs, the old constraint components will be deprecated. + /// public class FixedRotationToWorldConstraint : TransformConstraint { #region Properties + /// public override TransformFlags ConstraintType => TransformFlags.Rotate; #endregion Properties diff --git a/com.microsoft.mrtk.spatialmanipulation/Constraints/MaintainApparentSizeConstraint.cs b/com.microsoft.mrtk.spatialmanipulation/Constraints/MaintainApparentSizeConstraint.cs index a8cca5b0670..4a3bfca9766 100644 --- a/com.microsoft.mrtk.spatialmanipulation/Constraints/MaintainApparentSizeConstraint.cs +++ b/com.microsoft.mrtk.spatialmanipulation/Constraints/MaintainApparentSizeConstraint.cs @@ -7,15 +7,19 @@ namespace Microsoft.MixedReality.Toolkit.SpatialManipulation { /// /// Component for setting the min/max scale values for ObjectManipulator - /// or BoundsControl - /// We're looking to rework this system in the future. These existing components will be deprecated then. + /// or BoundsControl. /// + /// + /// MRTK's constraint system might be redesigned in the near future. When + /// this occurs, the old constraint components will be deprecated. + /// public class MaintainApparentSizeConstraint : TransformConstraint { #region Properties private float initialDist; + /// public override TransformFlags ConstraintType => TransformFlags.Scale; #endregion Properties diff --git a/com.microsoft.mrtk.spatialmanipulation/Constraints/MoveAxisConstraint.cs b/com.microsoft.mrtk.spatialmanipulation/Constraints/MoveAxisConstraint.cs index eecc1fd83d7..c8485431c79 100644 --- a/com.microsoft.mrtk.spatialmanipulation/Constraints/MoveAxisConstraint.cs +++ b/com.microsoft.mrtk.spatialmanipulation/Constraints/MoveAxisConstraint.cs @@ -7,9 +7,12 @@ namespace Microsoft.MixedReality.Toolkit.SpatialManipulation { /// /// Component for limiting the translation axes for ObjectManipulator - /// or BoundsControl - /// We're looking to rework this system in the future. These existing components will be deprecated then. + /// or BoundsControl. /// + /// + /// MRTK's constraint system might be redesigned in the near future. When + /// this occurs, the old constraint components will be deprecated. + /// public class MoveAxisConstraint : TransformConstraint { #region Properties @@ -41,6 +44,7 @@ public bool UseLocalSpaceForConstraint set => useLocalSpaceForConstraint = value; } + /// public override TransformFlags ConstraintType => TransformFlags.Move; #endregion Properties diff --git a/com.microsoft.mrtk.spatialmanipulation/Constraints/TransformConstraint.cs b/com.microsoft.mrtk.spatialmanipulation/Constraints/TransformConstraint.cs index 817cb3e1e37..9ecbf53cd8b 100644 --- a/com.microsoft.mrtk.spatialmanipulation/Constraints/TransformConstraint.cs +++ b/com.microsoft.mrtk.spatialmanipulation/Constraints/TransformConstraint.cs @@ -74,6 +74,9 @@ public int ExecutionPriority /// protected MixedRealityTransform InitialWorldPose; + /// + /// Get flags that describe the type of transformations this constraint applies to. + /// public abstract TransformFlags ConstraintType { get; } #endregion Properties diff --git a/com.microsoft.mrtk.uxcore/Button/BasicPressableButtonVisuals.cs b/com.microsoft.mrtk.uxcore/Button/BasicPressableButtonVisuals.cs index 6ff49737913..def3f5b4edc 100644 --- a/com.microsoft.mrtk.uxcore/Button/BasicPressableButtonVisuals.cs +++ b/com.microsoft.mrtk.uxcore/Button/BasicPressableButtonVisuals.cs @@ -6,8 +6,8 @@ namespace Microsoft.MixedReality.Toolkit.UX { /// - /// A simple visuals script to provide a visual layer on top of - /// . + /// A simple visuals script to provide a visual layer on top of a + /// PressableButton. /// [RequireComponent(typeof(PressableButton))] [ExecuteAlways] @@ -17,6 +17,7 @@ public class BasicPressableButtonVisuals : MonoBehaviour private PressableButton buttonState; [SerializeField] + [Tooltip("The front plate object that will move with the button displacement.")] private Transform movingVisuals; /// @@ -24,16 +25,19 @@ public class BasicPressableButtonVisuals : MonoBehaviour /// public Transform MovingVisuals => movingVisuals; - protected void Awake() + private void Awake() { buttonState = GetComponent(); } - protected void LateUpdate() + private void LateUpdate() { UpdateMovingVisualsPosition(); } + /// + /// Update the local position of the specified transform. + /// protected virtual void UpdateMovingVisualsPosition() { if (movingVisuals != null) diff --git a/com.microsoft.mrtk.uxcore/Button/PressableButton.cs b/com.microsoft.mrtk.uxcore/Button/PressableButton.cs index 9f890537bb8..d87587e4284 100644 --- a/com.microsoft.mrtk.uxcore/Button/PressableButton.cs +++ b/com.microsoft.mrtk.uxcore/Button/PressableButton.cs @@ -29,11 +29,18 @@ public class PressableButton : StatefulInteractable public bool SmoothSelectedness { get => smoothSelectedness; set => smoothSelectedness = value; } /// - /// Enum for defining space of plane distances. + /// An enumeration defining the coordinate space of plane distances. /// public enum SpaceMode { + /// + /// The world coordinate space system should be used. + // World, + + /// + /// The button's local coordinate space system should be used. + // Local } diff --git a/com.microsoft.mrtk.uxcore/Dialog/DialogEvents.cs b/com.microsoft.mrtk.uxcore/Dialog/DialogEvents.cs index 600642eb634..e4f3899d900 100644 --- a/com.microsoft.mrtk.uxcore/Dialog/DialogEvents.cs +++ b/com.microsoft.mrtk.uxcore/Dialog/DialogEvents.cs @@ -21,10 +21,8 @@ public abstract class BaseDialogEventArgs } /// - /// Button events emit these parameters. For subclassed dialogs - /// with custom buttons or other types of events, return - /// a with some additional - /// context in a subclassed IDialog + /// are clicked or activated. /// public class DialogButtonEventArgs : BaseDialogEventArgs { @@ -45,6 +43,10 @@ public class DialogButtonEventArgs : BaseDialogEventArgs public string ButtonText { get; set; } } + /// + /// Event arguments used a IDialog + /// is dismissed or closed. + /// public class DialogDismissedEventArgs : BaseDialogEventArgs { /// @@ -53,5 +55,4 @@ public class DialogDismissedEventArgs : BaseDialogEventArgs /// public DialogButtonEventArgs Choice { get; set; } } - } \ No newline at end of file diff --git a/com.microsoft.mrtk.uxcore/Interop/CanvasProxyInteractor.cs b/com.microsoft.mrtk.uxcore/Interop/CanvasProxyInteractor.cs index 40ee11c82bb..42e1ab556a0 100644 --- a/com.microsoft.mrtk.uxcore/Interop/CanvasProxyInteractor.cs +++ b/com.microsoft.mrtk.uxcore/Interop/CanvasProxyInteractor.cs @@ -8,13 +8,20 @@ namespace Microsoft.MixedReality.Toolkit.UX { /// - /// A simple proxy interactor which will select + hover things on our behalf, for canvas input. + /// A simple proxy interactor which will select and hover things on MRTK's behalf, for canvas input. /// [AddComponentMenu("MRTK/UX/Canvas Proxy Interactor")] public class CanvasProxyInteractor : XRBaseInteractor, IProxyInteractor, IModeManagedInteractor { + /// + /// The hash set containing a collection of valid interactable targets for this this interactor. + /// protected HashSet validTargets = new HashSet(); + /// + /// The last target selected using the method. This value will + /// be cleared when is called. + /// protected IXRSelectInteractable manualSelectTarget; // We set this flag whenever we're cancelling an interaction. This will suppress diff --git a/com.microsoft.mrtk.uxcore/LegacyDialog/Dialog.cs b/com.microsoft.mrtk.uxcore/LegacyDialog/Dialog.cs index 4660b4452e8..2e9930733ba 100644 --- a/com.microsoft.mrtk.uxcore/LegacyDialog/Dialog.cs +++ b/com.microsoft.mrtk.uxcore/LegacyDialog/Dialog.cs @@ -9,13 +9,20 @@ namespace Microsoft.MixedReality.Toolkit.UX.Deprecated /// /// Abstract class that presents a Dialog object. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + /// + /// The Dialog. If you'd like to continue using the + /// Legacy Dialog implementation, it is recommend that the legacy code + /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommend + /// that the application be updated to use the new Dialog system. + /// + [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog system.")] public abstract class Dialog : MonoBehaviour { /// /// The current state of the dialog. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog system.")] public DialogState State { get; protected set; } = DialogState.Uninitialized; /// diff --git a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonTypes.cs b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonTypes.cs index 5efffa44918..af557681e27 100644 --- a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonTypes.cs +++ b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonTypes.cs @@ -6,18 +6,56 @@ namespace Microsoft.MixedReality.Toolkit.UX.Deprecated { /// - /// The style of button on a dialog. + /// The style of a legacy dialog button. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + /// + /// This and the Dialog. If you'd like to continue using the + /// Legacy Dialog implementation, it is recommend that the legacy code + /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommend + /// that the application be updated to use the new Dialog system. + /// + [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog system.")] public enum DialogButtonType { + /// + /// An unspecified button type. + /// None = 0, + + /// + /// Represent a close dialog button. + /// Close = 1, + + /// + /// Represent a confirmation dialog button. + /// Confirm = 2, + + /// + /// Represent a cancel dialog button. + /// Cancel = 3, + + /// + /// Represent an accept dialog button. + /// Accept = 4, + + /// + /// Represent a "yes" dialog button. + /// Yes = 5, + + /// + /// Represent a "no" dialog button. + /// No = 6, + + /// + /// Represent an "okay" dialog button. + /// OK = 7, } diff --git a/com.microsoft.mrtk.uxcore/ObjectBar/ObjectBarFlowDirection.cs b/com.microsoft.mrtk.uxcore/ObjectBar/ObjectBarFlowDirection.cs index 5541d39aaa1..446c19445e9 100644 --- a/com.microsoft.mrtk.uxcore/ObjectBar/ObjectBarFlowDirection.cs +++ b/com.microsoft.mrtk.uxcore/ObjectBar/ObjectBarFlowDirection.cs @@ -4,11 +4,18 @@ namespace Microsoft.MixedReality.Toolkit.UX { /// - /// The flow direction for objects in an Object Bar. + /// The flow direction for objects in an ObjectBar. /// public enum ObjectBarFlowDirection { + /// + /// Objects in an ObjectBar will flow in the horizontal direction. + /// Horizontal, + + /// + /// Objects in an ObjectBar will flow in the vertical direction. + /// Vertical } -} +} \ No newline at end of file diff --git a/com.microsoft.mrtk.uxcore/Toggle/ToggleCollection.cs b/com.microsoft.mrtk.uxcore/Toggle/ToggleCollection.cs index 76c33ac624a..b471ecbb837 100644 --- a/com.microsoft.mrtk.uxcore/Toggle/ToggleCollection.cs +++ b/com.microsoft.mrtk.uxcore/Toggle/ToggleCollection.cs @@ -10,7 +10,7 @@ namespace Microsoft.MixedReality.Toolkit.UX /// /// ToggleCollection groups a list of StatefulInteractables and correlates their /// toggle states. When any one of the StatefulInteractables are toggled, all other - /// interactables controlled by this script will be detoggled. + /// interactables controlled by this script will be de-toggled. /// A custom list of interactables can be set; if none is set at edit-time, all direct /// StatefulInteractable children will be added. /// @@ -74,7 +74,7 @@ public bool AllowSwitchOff } [SerializeField] - [Tooltip("Currently selected index in the ToggleList, default is 0")] + [Tooltip("Currently selected index in the ToggleCollection, default is 0")] private int currentIndex; /// @@ -86,19 +86,19 @@ public int CurrentIndex set => SetSelection(value); } - [Tooltip("This event is triggered when any of the toggles in the ToggleList are selected. The event data is the index of the toggle in the ToggleList selected.")] + [Tooltip("This event is triggered when any of the toggles in the ToggleCollection are selected. The event data is the index of the toggle button with in the ToggleCollection.")] [SerializeField] private ToggleSelectedEvent onToggleSelected = new ToggleSelectedEvent(); /// - /// This event is triggered when any of the toggles in the ToggleList are selected. The event data is the index of the toggle in the ToggleList selected. + /// This event is triggered when any of the toggles in the are selected. The event data is the index of the toggle button within the . /// public ToggleSelectedEvent OnToggleSelected { get => onToggleSelected; } - // List of the actions for the toggles in ToggleList + // List of the actions for the toggles in ToggleCollection private List> toggleActions = new List>(); private void OnValidate() @@ -131,7 +131,7 @@ private void Start() } if (Toggles != null && toggleActions.Count == 0) { - // Add listeners to each toggle in ToggleList + // Add listeners to each toggle in ToggleCollection AddSelectionListeners(); // Force set initial selection in the toggle collection at start @@ -148,14 +148,14 @@ private void Start() /// /// Set the selection of a an element in the toggle collection based on index. - /// Index of an element in ToggleList - /// Force selection set + /// Index of an element in the . + /// Force selection to be set. /// public void SetSelection(int index, bool force = false) { if (index < 0 || Toggles.Count <= index || Toggles == null || !isActiveAndEnabled) { - Debug.LogWarning("Index out of range of ToggleList: " + index); + Debug.LogWarning("Index out of range of ToggleCollection: " + index); return; } diff --git a/com.microsoft.mrtk.uxcore/Toggle/ToggleSelectedEvent.cs b/com.microsoft.mrtk.uxcore/Toggle/ToggleSelectedEvent.cs index 70533a71a9c..2ae17d1795e 100644 --- a/com.microsoft.mrtk.uxcore/Toggle/ToggleSelectedEvent.cs +++ b/com.microsoft.mrtk.uxcore/Toggle/ToggleSelectedEvent.cs @@ -6,6 +6,11 @@ namespace Microsoft.MixedReality.Toolkit.UX { + /// + /// A Unity event raised by ToggleCollection + /// when any of the toggle buttons are selected. The event data is the index of the toggle button within the + /// . + /// [Serializable] public class ToggleSelectedEvent : UnityEvent { } } \ No newline at end of file diff --git a/com.microsoft.mrtk.windowsspeech/Subsystems/TextToSpeech/WindowsTextToSpeechSubsystem.cs b/com.microsoft.mrtk.windowsspeech/Subsystems/TextToSpeech/WindowsTextToSpeechSubsystem.cs index 277030d06e5..893a092ee1d 100644 --- a/com.microsoft.mrtk.windowsspeech/Subsystems/TextToSpeech/WindowsTextToSpeechSubsystem.cs +++ b/com.microsoft.mrtk.windowsspeech/Subsystems/TextToSpeech/WindowsTextToSpeechSubsystem.cs @@ -17,6 +17,14 @@ namespace Microsoft.MixedReality.Toolkit.Speech.Windows { + /// + /// A Unity subsystem that extends TextToSpeechSubsystem + /// so to expose the text to speech services available on Windows platforms. This subsystem is enabled for Windows Standalone and + /// Universal Windows Applications. + /// + /// + /// This subsystem can be configured using the WindowsKeywordRecognitionSubsystemConfig Unity asset. + /// [Preserve] [MRTKSubsystem( Name = "com.microsoft.mrtk.windowsspeech.texttospeech", @@ -39,6 +47,10 @@ static void Register() } } + /// + /// A subsystem provider for that exposes methods on the Windows + /// speech synthesizer systems. + /// [Preserve] class WindowsTextToSpeechSubsystemProvider : Provider { diff --git a/com.microsoft.mrtk.windowsspeech/Subsystems/WindowsDictationSubsystem.cs b/com.microsoft.mrtk.windowsspeech/Subsystems/WindowsDictationSubsystem.cs index 56e8af813d8..a03776de018 100644 --- a/com.microsoft.mrtk.windowsspeech/Subsystems/WindowsDictationSubsystem.cs +++ b/com.microsoft.mrtk.windowsspeech/Subsystems/WindowsDictationSubsystem.cs @@ -11,6 +11,14 @@ namespace Microsoft.MixedReality.Toolkit.Speech.Windows { + /// + /// A Unity subsystem that extends DictationSubsystem + /// so to expose the dictation services available on Windows platforms. This subsystem is enabled for Windows Standalone and + /// Universal Windows Applications. + /// + /// + /// This subsystem can be configured using the WindowsDictationSubsystemConfig Unity asset. + /// [Preserve] [MRTKSubsystem( Name = "com.microsoft.mixedreality.windowsdictation", @@ -33,6 +41,10 @@ static void Register() } } + /// + /// A subsystem provider used with class that exposes methods on Unity's `DictationRecognizer` + /// on Windows platforms. + /// [Preserve] class WindowsDictationProvider : Provider { diff --git a/com.microsoft.mrtk.windowsspeech/Subsystems/WindowsDictationSubsystemConfig.cs b/com.microsoft.mrtk.windowsspeech/Subsystems/WindowsDictationSubsystemConfig.cs index 867c10e376e..67fca5bc768 100644 --- a/com.microsoft.mrtk.windowsspeech/Subsystems/WindowsDictationSubsystemConfig.cs +++ b/com.microsoft.mrtk.windowsspeech/Subsystems/WindowsDictationSubsystemConfig.cs @@ -10,7 +10,7 @@ namespace Microsoft.MixedReality.Toolkit.Speech.Windows { /// - /// The configuration object for WindowsDictationSubsystem. + /// The configuration object for WindowsDictationSubsystem. /// [CreateAssetMenu( fileName = "WindowsDictationSubsystemConfig.asset", diff --git a/com.microsoft.mrtk.windowsspeech/Subsystems/WindowsKeywordRecognitionSubsystem.cs b/com.microsoft.mrtk.windowsspeech/Subsystems/WindowsKeywordRecognitionSubsystem.cs index 95c07222c7b..2a7665bf142 100644 --- a/com.microsoft.mrtk.windowsspeech/Subsystems/WindowsKeywordRecognitionSubsystem.cs +++ b/com.microsoft.mrtk.windowsspeech/Subsystems/WindowsKeywordRecognitionSubsystem.cs @@ -19,6 +19,14 @@ namespace Microsoft.MixedReality.Toolkit.Speech.Windows { + /// + /// A Unity subsystem that extends KeywordRecognitionSubsystem + /// so to expose the keyword recognition services available on Windows platforms. This subsystem is enabled for Windows Standalone and + /// Universal Windows Applications. + /// + /// + /// This subsystem can be configured using the WindowsKeywordRecognitionSubsystemConfig Unity asset. + /// [Preserve] [MRTKSubsystem( Name = "com.microsoft.mixedreality.windowskeywordrecognition", @@ -41,6 +49,11 @@ static void Register() } } + /// + /// A subsystem provider used with that exposes methods on the + /// SelectKeywordRecognizer and Unity's + /// `KeywordRecognizer`. + /// [Preserve] class WindowsKeywordRecognitionProvider : Provider { diff --git a/com.microsoft.mrtk.windowsspeech/Subsystems/WindowsKeywordRecognitionSubsystemConfig.cs b/com.microsoft.mrtk.windowsspeech/Subsystems/WindowsKeywordRecognitionSubsystemConfig.cs index 95855afc233..f9a9904928e 100644 --- a/com.microsoft.mrtk.windowsspeech/Subsystems/WindowsKeywordRecognitionSubsystemConfig.cs +++ b/com.microsoft.mrtk.windowsspeech/Subsystems/WindowsKeywordRecognitionSubsystemConfig.cs @@ -10,7 +10,7 @@ namespace Microsoft.MixedReality.Toolkit.Speech.Windows { /// - /// The configuration object for WindowsKeywordRecognitionSubsystem. + /// The configuration object for WindowsKeywordRecognitionSubsystem. /// [CreateAssetMenu( fileName = "WindowsKeywordRecognitionSubsystemConfig.asset", From b7bda12ba565b306827d3df178c4cb5375e42de8 Mon Sep 17 00:00:00 2001 From: Adam Mollis Date: Mon, 12 Jun 2023 10:27:59 -0700 Subject: [PATCH 2/5] Fixing grammar --- com.microsoft.mrtk.uxcore/LegacyDialog/Dialog.cs | 2 +- com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonTypes.cs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/com.microsoft.mrtk.uxcore/LegacyDialog/Dialog.cs b/com.microsoft.mrtk.uxcore/LegacyDialog/Dialog.cs index 2e9930733ba..f6b6dce1f86 100644 --- a/com.microsoft.mrtk.uxcore/LegacyDialog/Dialog.cs +++ b/com.microsoft.mrtk.uxcore/LegacyDialog/Dialog.cs @@ -13,7 +13,7 @@ namespace Microsoft.MixedReality.Toolkit.UX.Deprecated /// The Dialog. If you'd like to continue using the /// Legacy Dialog implementation, it is recommend that the legacy code - /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommend + /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommended /// that the application be updated to use the new Dialog system. /// [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog system.")] diff --git a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonTypes.cs b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonTypes.cs index af557681e27..370c1ec475e 100644 --- a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonTypes.cs +++ b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonTypes.cs @@ -12,7 +12,7 @@ namespace Microsoft.MixedReality.Toolkit.UX.Deprecated /// This and the Dialog. If you'd like to continue using the /// Legacy Dialog implementation, it is recommend that the legacy code - /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommend + /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommended /// that the application be updated to use the new Dialog system. /// [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog system.")] From 2bd23c3870baba59b36df9acdd0a0a9efcc037d0 Mon Sep 17 00:00:00 2001 From: Adam Mollis Date: Mon, 12 Jun 2023 11:01:22 -0700 Subject: [PATCH 3/5] Small modification --- .../Subsystems/SyntheticHands/SyntheticHandsConfig.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/com.microsoft.mrtk.input/Subsystems/SyntheticHands/SyntheticHandsConfig.cs b/com.microsoft.mrtk.input/Subsystems/SyntheticHands/SyntheticHandsConfig.cs index bd134ba65a0..87e425ebe21 100644 --- a/com.microsoft.mrtk.input/Subsystems/SyntheticHands/SyntheticHandsConfig.cs +++ b/com.microsoft.mrtk.input/Subsystems/SyntheticHands/SyntheticHandsConfig.cs @@ -7,8 +7,8 @@ namespace Microsoft.MixedReality.Toolkit.Input { /// - /// A configuration object for the SyntheticHandsSubsystem - /// class. This class defines the Unity input actions that SyntheticHandsSubsystem + /// A configuration object for SyntheticHandsSubsystem. + /// This class defines the Unity input actions that SyntheticHandsSubsystem /// uses when simulating articulated hands. /// [CreateAssetMenu(fileName = "MRTKSyntheticHandsConfig.asset", menuName = "MRTK/Subsystems/MRTK Synthetic Hands Config")] From cfbefdcb51ef29fb253bb5732db2731b944e5d9a Mon Sep 17 00:00:00 2001 From: Adam Mollis Date: Wed, 14 Jun 2023 22:01:45 -0700 Subject: [PATCH 4/5] Addressing PR feedback...and fixing some dialog comments --- com.microsoft.mrtk.uxcore/Dialog/Dialog.cs | 8 ++- .../Dialog/DialogPool.cs | 9 +-- com.microsoft.mrtk.uxcore/Dialog/IDialog.cs | 11 ++-- .../LegacyDialog/Dialog.cs | 4 +- .../LegacyDialog/DialogButton.cs | 23 +++++--- .../LegacyDialog/DialogButtonContext.cs | 15 +++-- .../LegacyDialog/DialogButtonHelpers.cs | 14 ++++- .../LegacyDialog/DialogButtonTypes.cs | 58 +++++++++++++++---- .../LegacyDialog/DialogProperty.cs | 31 ++++++---- .../LegacyDialog/DialogShell.cs | 19 ++++-- .../LegacyDialog/DialogState.cs | 24 +++++++- .../Toggle/ToggleCollection.cs | 9 +-- 12 files changed, 164 insertions(+), 61 deletions(-) diff --git a/com.microsoft.mrtk.uxcore/Dialog/Dialog.cs b/com.microsoft.mrtk.uxcore/Dialog/Dialog.cs index 6eb9c0b610b..63e7979a979 100644 --- a/com.microsoft.mrtk.uxcore/Dialog/Dialog.cs +++ b/com.microsoft.mrtk.uxcore/Dialog/Dialog.cs @@ -19,7 +19,13 @@ namespace Microsoft.MixedReality.Toolkit.UX /// /// The Dialog script hydrates and controls the various sub-components /// of the dialog view. - /// + /// + /// + /// Dialogs are typically spawned, pooled, and killed + /// by DialogPools. + /// Generally, developers should not directly manage or instantiate instances of their dialogs, + /// as it is essential that they are pooled and managed correctly by a pooler. + /// [AddComponentMenu("MRTK/UX/Dialog")] public class Dialog : MonoBehaviour, IDialog { diff --git a/com.microsoft.mrtk.uxcore/Dialog/DialogPool.cs b/com.microsoft.mrtk.uxcore/Dialog/DialogPool.cs index 0f9cc9cc6fc..e18170dffa0 100644 --- a/com.microsoft.mrtk.uxcore/Dialog/DialogPool.cs +++ b/com.microsoft.mrtk.uxcore/Dialog/DialogPool.cs @@ -15,8 +15,8 @@ namespace Microsoft.MixedReality.Toolkit.UX { /// - /// Spawns dialogs with the requested parameters and manages - /// the lifecycle of the resulting dialog component. + /// Spawns IDialog with the requested parameters and manages + /// the lifecycle of the resulting IDialog component. /// [ExecuteAlways] [AddComponentMenu("MRTK/UX/Dialog Pool")] @@ -36,9 +36,10 @@ public enum Policy } /// - /// The default prefab to instantiate when spawning a dialog. + /// The default prefab to instantiate when spawning a dialog. This prefab must + /// contain a IDialog component. /// - [field: SerializeField, Tooltip("The default prefab to instantiate when spawning a dialog.")] + [field: SerializeField, Tooltip("The default prefab to instantiate when spawning a dialog. This prefab must contain a IDialog component.")] public GameObject DialogPrefab { get; set; } // Static reference to the dialog instance, if active and spawned. diff --git a/com.microsoft.mrtk.uxcore/Dialog/IDialog.cs b/com.microsoft.mrtk.uxcore/Dialog/IDialog.cs index 682a8dd6c76..d3ef5f8f75d 100644 --- a/com.microsoft.mrtk.uxcore/Dialog/IDialog.cs +++ b/com.microsoft.mrtk.uxcore/Dialog/IDialog.cs @@ -30,11 +30,14 @@ public enum DialogButtonType /// /// An IDialog hydrates and controls the various sub-components - /// of the dialog view. IDialogs are spawned, pooled, and killed - /// by DialogPools. Generally, developers should not directly - /// manage or instantiate instances of their dialogs, as it is - /// essential that they are pooled and managed correctly by a pooler. + /// of the dialog view. /// + /// + /// IDialogs are typically spawned, pooled, and killed + /// by DialogPools. + /// Generally, developers should not directly manage or instantiate instances of their dialogs, + /// as it is essential that they are pooled and managed correctly by a pooler. + /// public interface IDialog { /// diff --git a/com.microsoft.mrtk.uxcore/LegacyDialog/Dialog.cs b/com.microsoft.mrtk.uxcore/LegacyDialog/Dialog.cs index f6b6dce1f86..bb9be794d90 100644 --- a/com.microsoft.mrtk.uxcore/LegacyDialog/Dialog.cs +++ b/com.microsoft.mrtk.uxcore/LegacyDialog/Dialog.cs @@ -16,13 +16,13 @@ namespace Microsoft.MixedReality.Toolkit.UX.Deprecated /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommended /// that the application be updated to use the new Dialog system. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog system.")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public abstract class Dialog : MonoBehaviour { /// /// The current state of the dialog. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog system.")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public DialogState State { get; protected set; } = DialogState.Uninitialized; /// diff --git a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButton.cs b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButton.cs index 2b1aa41205a..bc07fdd3b50 100644 --- a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButton.cs +++ b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButton.cs @@ -10,7 +10,14 @@ namespace Microsoft.MixedReality.Toolkit.UX.Deprecated /// /// Handling click event and dismiss dialog /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + /// + /// This and the Dialog. If you'd like to continue using the + /// Legacy Dialog implementation, it is recommend that the legacy code + /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommended + /// that the application be updated to use the new Dialog system. + /// + [SerializeField, Tooltip("The TextMeshPro component for displaying text on the button itself.")] public class DialogButton : MonoBehaviour { [SerializeField, Tooltip("The TextMeshPro component for displaying text on the button itself.")] @@ -19,7 +26,7 @@ public class DialogButton : MonoBehaviour /// /// The TextMeshPro component for displaying text on the button itself. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public TMP_Text ButtonText { get => buttonText; @@ -29,13 +36,13 @@ public TMP_Text ButtonText /// /// A reference to the Dialog that this button is on. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public Dialog ParentDialog { get; set; } /// /// The type description of the button. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public DialogButtonTypes ButtonTypeEnum => DialogProperty.Convert(ButtonContext.ButtonType); [SerializeField, Tooltip("The type description of the button.")] @@ -44,7 +51,7 @@ public TMP_Text ButtonText /// /// The context, including type and an optional label, of the button. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public DialogButtonContext ButtonContext => buttonContext; private void OnValidate() @@ -56,7 +63,7 @@ private void OnValidate() /// Event handler that runs when button is clicked. /// Dismisses the parent dialog. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public void OnButtonClicked() { if (ParentDialog != null) @@ -73,7 +80,7 @@ public void OnButtonClicked() /// Sets the label text on the button. /// /// New label text for the button. - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public void SetLabel(string label) { buttonContext.Label = label; @@ -88,7 +95,7 @@ public void SetLabel(string label) /// Sets the button context and the label text on the button. /// /// New button context for this button. - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public void SetButtonContext(DialogButtonContext buttonContext) { this.buttonContext = buttonContext; diff --git a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonContext.cs b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonContext.cs index a8c76ab6892..942a231da18 100644 --- a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonContext.cs +++ b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonContext.cs @@ -9,11 +9,18 @@ namespace Microsoft.MixedReality.Toolkit.UX.Deprecated /// /// Represents a button with its type and an optional custom label. /// + /// + /// This and the Dialog. If you'd like to continue using the + /// Legacy Dialog implementation, it is recommend that the legacy code + /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommended + /// that the application be updated to use the new Dialog system. + /// [Serializable] - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public struct DialogButtonContext { - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public DialogButtonContext(DialogButtonType buttonType, string label = null) { ButtonType = buttonType; @@ -24,7 +31,7 @@ public DialogButtonContext(DialogButtonType buttonType, string label = null) /// The type of this button. /// [field: SerializeField, Tooltip("The type of this button.")] - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public DialogButtonType ButtonType { get; internal set; } /// @@ -32,7 +39,7 @@ public DialogButtonContext(DialogButtonType buttonType, string label = null) /// /// If none is provided, the string representation of will be used. [field: SerializeField, Tooltip("The optional label for this button. If none is provided, the string representation of Button Type will be used.")] - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public string Label { get; internal set; } } } diff --git a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonHelpers.cs b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonHelpers.cs index 20737c32634..62454888e21 100644 --- a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonHelpers.cs +++ b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonHelpers.cs @@ -8,24 +8,32 @@ namespace Microsoft.MixedReality.Toolkit.UX.Deprecated /// /// Provides a pre-defined set of button contexts for ease of dialog creation. /// + /// + /// This and the Dialog. If you'd like to continue using the + /// Legacy Dialog implementation, it is recommend that the legacy code + /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommended + /// that the application be updated to use the new Dialog system. + /// + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public static class DialogButtonHelpers { /// /// Represents a single OK button. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public static DialogButtonContext[] OK { get; } = new DialogButtonContext[] { new DialogButtonContext(DialogButtonType.OK) }; /// /// Represents a pair of OK and Cancel buttons. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public static DialogButtonContext[] OKCancel { get; } = new DialogButtonContext[] { new DialogButtonContext(DialogButtonType.OK), new DialogButtonContext(DialogButtonType.Cancel) }; /// /// Represents a pair of Yes and No buttons. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public static DialogButtonContext[] YesNo { get; } = new DialogButtonContext[] { new DialogButtonContext(DialogButtonType.Yes), new DialogButtonContext(DialogButtonType.No) }; } } diff --git a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonTypes.cs b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonTypes.cs index 370c1ec475e..70b70d2a5b7 100644 --- a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonTypes.cs +++ b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonTypes.cs @@ -15,7 +15,7 @@ namespace Microsoft.MixedReality.Toolkit.UX.Deprecated /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommended /// that the application be updated to use the new Dialog system. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog system.")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public enum DialogButtonType { /// @@ -24,55 +24,93 @@ public enum DialogButtonType None = 0, /// - /// Represent a close dialog button. + /// Represents a close dialog button. /// Close = 1, /// - /// Represent a confirmation dialog button. + /// Represents a confirmation dialog button. /// Confirm = 2, /// - /// Represent a cancel dialog button. + /// Represents a cancel dialog button. /// Cancel = 3, /// - /// Represent an accept dialog button. + /// Represents an accept dialog button. /// Accept = 4, /// - /// Represent a "yes" dialog button. + /// Represents a "yes" dialog button. /// Yes = 5, /// - /// Represent a "no" dialog button. + /// Represents a "no" dialog button. /// No = 6, /// - /// Represent an "okay" dialog button. + /// Represents an "okay" dialog button. /// OK = 7, } /// - /// The style of button on a dialog. + /// The style of a legacy dialog button. /// + /// + /// This and the Dialog. If you'd like to continue using the + /// Legacy Dialog implementation, it is recommend that the legacy code + /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommended + /// that the application be updated to use the new Dialog system. + /// [Flags] - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public enum DialogButtonTypes { + /// + /// No button style has been specified. + /// None = 0 << 0, + + /// + /// Represents a close dialog button. + /// Close = 1 << 0, + + /// + /// Represents a confirmation dialog button. + /// Confirm = 1 << 1, + + /// + /// Represents a cancel dialog button. + /// Cancel = 1 << 2, + + /// + /// Represents an accept dialog button. + /// Accept = 1 << 3, + + /// + /// Represents a "yes" dialog button. + /// Yes = 1 << 4, + + /// + /// Represents a "no" dialog button. + /// No = 1 << 5, + + /// + /// Represents an "okay" dialog button. + /// OK = 1 << 6, } } diff --git a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogProperty.cs b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogProperty.cs index d3197de00be..982b014257c 100644 --- a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogProperty.cs +++ b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogProperty.cs @@ -9,7 +9,14 @@ namespace Microsoft.MixedReality.Toolkit.UX.Deprecated /// /// Object containing properties about a dialog. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + /// + /// This and the Dialog. If you'd like to continue using the + /// Legacy Dialog implementation, it is recommend that the legacy code + /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommended + /// that the application be updated to use the new Dialog system. + /// + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public class DialogProperty { /// @@ -18,7 +25,7 @@ public class DialogProperty /// The title bar string (top-most) on the dialog. /// The message content string of the dialog. /// The button type(s) available on the dialog. - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public DialogProperty(string title, string message, params DialogButtonContext[] buttonContexts) { Title = title; @@ -33,7 +40,7 @@ public DialogProperty(string title, string message, params DialogButtonContext[] ButtonContexts = buttonContexts; } - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public DialogProperty(string title, string message, DialogButtonTypes buttonTypes) : this(title, message) { List buttonTypesList = new List(); @@ -49,7 +56,7 @@ public DialogProperty(string title, string message, DialogButtonTypes buttonType ButtonContexts = buttonTypesList.ToArray(); } - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] private static DialogButtonType Convert(DialogButtonTypes dialogButtonTypes) { switch (dialogButtonTypes) @@ -66,7 +73,7 @@ private static DialogButtonType Convert(DialogButtonTypes dialogButtonTypes) } } - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] internal static DialogButtonTypes Convert(DialogButtonType dialogButtonTypes) { switch (dialogButtonTypes) @@ -86,43 +93,43 @@ internal static DialogButtonTypes Convert(DialogButtonType dialogButtonTypes) /// /// The title bar string (top-most) on the dialog. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public string Title { get; } = string.Empty; /// /// The message content string of the dialog. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public string Message { get; } = string.Empty; /// /// The button type(s) available on the dialog. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public DialogButtonTypes ButtonTypes { get; } = DialogButtonTypes.Close; /// /// Contexts for the buttons, in order of their appearance on the dialog. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public IReadOnlyList ButtonContexts { get; } = null; /// /// Which button was clicked to dismiss the dialog. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public DialogButtonTypes Result => Convert(ResultContext.ButtonType); /// /// Which button was clicked to dismiss the dialog. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public DialogButtonContext ResultContext { get; internal set; } = default; /// /// Reference to the dialog this property applies to. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public Dialog TargetDialog { get; internal set; } } } diff --git a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogShell.cs b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogShell.cs index ce84ed1c4fc..a044c5e3058 100644 --- a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogShell.cs +++ b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogShell.cs @@ -13,7 +13,14 @@ namespace Microsoft.MixedReality.Toolkit.UX.Deprecated /// DialogShell class manages a dialog object that can have one or two option buttons. /// If you try to open a dialog with more than two option buttons, it will show the first two. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + /// + /// This and the Dialog. If you'd like to continue using the + /// Legacy Dialog implementation, it is recommend that the legacy code + /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommended + /// that the application be updated to use the new Dialog system. + /// + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public class DialogShell : Dialog { [SerializeField] @@ -23,7 +30,7 @@ public class DialogShell : Dialog /// /// Title text of the dialog /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public TMP_Text TitleText { get { return titleText; } @@ -37,7 +44,7 @@ public TMP_Text TitleText /// /// Description text of the dialog /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public TMP_Text DescriptionText { get { return descriptionText; } @@ -45,11 +52,11 @@ public TMP_Text DescriptionText } /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] protected override void FinalizeLayout() { } /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] protected override void GenerateButtons() { // Find all buttons on dialog... @@ -106,7 +113,7 @@ private List GetAllDialogButtons() /// /// Set Title and Text on the Dialog. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] protected override void SetTitleAndMessage() { if (titleText != null) diff --git a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogState.cs b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogState.cs index 5eb7d60e816..93303b17408 100644 --- a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogState.cs +++ b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogState.cs @@ -8,12 +8,34 @@ namespace Microsoft.MixedReality.Toolkit.UX.Deprecated /// /// Describes the current state of a Dialog. /// - [Obsolete("Legacy Dialog is deprecated. Please migrate to the new Dialog. See uxcore/LegacyDialog/README.md")] + /// + /// This and the Dialog. If you'd like to continue using the + /// Legacy Dialog implementation, it is recommend that the legacy code + /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommended + /// that the application be updated to use the new Dialog system. + /// + [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public enum DialogState { + /// + /// The dialog has not been opened or closed yet. + /// Uninitialized = 0, + + /// + /// The dialog is the the process of opening. + /// Opening, + + /// + /// The dialog is opened and is ready of input. + /// WaitingForInput, + + /// + /// The dialog is now closed. + /// Closed } } \ No newline at end of file diff --git a/com.microsoft.mrtk.uxcore/Toggle/ToggleCollection.cs b/com.microsoft.mrtk.uxcore/Toggle/ToggleCollection.cs index b471ecbb837..97e54916cdd 100644 --- a/com.microsoft.mrtk.uxcore/Toggle/ToggleCollection.cs +++ b/com.microsoft.mrtk.uxcore/Toggle/ToggleCollection.cs @@ -54,11 +54,8 @@ public List Toggles private bool allowSwitchOff = false; /// - /// Should the user be allowed to un-toggle the toggles? + /// Get or set if the user is allowed to un-toggle the toggle buttons. /// - /// - /// Same name and behaviour as UnityUI's ToggleGroup. - /// public bool AllowSwitchOff { get => allowSwitchOff; @@ -98,7 +95,7 @@ public ToggleSelectedEvent OnToggleSelected get => onToggleSelected; } - // List of the actions for the toggles in ToggleCollection + // List of the actions for the toggles in ToggleCollection. private List> toggleActions = new List>(); private void OnValidate() @@ -131,7 +128,7 @@ private void Start() } if (Toggles != null && toggleActions.Count == 0) { - // Add listeners to each toggle in ToggleCollection + // Add listeners to each toggle in ToggleCollection. AddSelectionListeners(); // Force set initial selection in the toggle collection at start From bfcb14deb79c1e51e0d68f6ca4b37d5ac30e4fb8 Mon Sep 17 00:00:00 2001 From: Adam Mollis Date: Wed, 14 Jun 2023 22:12:48 -0700 Subject: [PATCH 5/5] Updating dialog comments some more --- com.microsoft.mrtk.uxcore/LegacyDialog/Dialog.cs | 6 +++--- .../LegacyDialog/DialogButton.cs | 6 +++--- .../LegacyDialog/DialogButtonContext.cs | 6 +++--- .../LegacyDialog/DialogButtonHelpers.cs | 6 +++--- .../LegacyDialog/DialogButtonTypes.cs | 12 ++++++------ .../LegacyDialog/DialogProperty.cs | 6 +++--- .../LegacyDialog/DialogShell.cs | 6 +++--- .../LegacyDialog/DialogState.cs | 6 +++--- 8 files changed, 27 insertions(+), 27 deletions(-) diff --git a/com.microsoft.mrtk.uxcore/LegacyDialog/Dialog.cs b/com.microsoft.mrtk.uxcore/LegacyDialog/Dialog.cs index bb9be794d90..3601cc4bc9e 100644 --- a/com.microsoft.mrtk.uxcore/LegacyDialog/Dialog.cs +++ b/com.microsoft.mrtk.uxcore/LegacyDialog/Dialog.cs @@ -10,11 +10,11 @@ namespace Microsoft.MixedReality.Toolkit.UX.Deprecated /// Abstract class that presents a Dialog object. /// /// - /// The Legacy Dialog is deprecated. Please migrate to the /// new Dialog. If you'd like to continue using the - /// Legacy Dialog implementation, it is recommend that the legacy code + /// Legacy Dialog implementation, it is recommended that the legacy code /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommended - /// that the application be updated to use the new Dialog system. + /// that the application be updated to use the new DialogPool system. /// [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public abstract class Dialog : MonoBehaviour diff --git a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButton.cs b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButton.cs index bc07fdd3b50..a73a3360e59 100644 --- a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButton.cs +++ b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButton.cs @@ -11,11 +11,11 @@ namespace Microsoft.MixedReality.Toolkit.UX.Deprecated /// Handling click event and dismiss dialog /// /// - /// This and the Legacy Dialog are deprecated. Please migrate to the /// new Dialog. If you'd like to continue using the - /// Legacy Dialog implementation, it is recommend that the legacy code + /// Legacy Dialog implementation, it is recommended that the legacy code /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommended - /// that the application be updated to use the new Dialog system. + /// that the application be updated to use the new DialogPool system. /// [SerializeField, Tooltip("The TextMeshPro component for displaying text on the button itself.")] public class DialogButton : MonoBehaviour diff --git a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonContext.cs b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonContext.cs index 942a231da18..08d59855fbb 100644 --- a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonContext.cs +++ b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonContext.cs @@ -10,11 +10,11 @@ namespace Microsoft.MixedReality.Toolkit.UX.Deprecated /// Represents a button with its type and an optional custom label. /// /// - /// This and the Legacy Dialog are deprecated. Please migrate to the /// new Dialog. If you'd like to continue using the - /// Legacy Dialog implementation, it is recommend that the legacy code + /// Legacy Dialog implementation, it is recommended that the legacy code /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommended - /// that the application be updated to use the new Dialog system. + /// that the application be updated to use the new DialogPool system. /// [Serializable] [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] diff --git a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonHelpers.cs b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonHelpers.cs index 62454888e21..0cbb9466d4a 100644 --- a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonHelpers.cs +++ b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonHelpers.cs @@ -9,11 +9,11 @@ namespace Microsoft.MixedReality.Toolkit.UX.Deprecated /// Provides a pre-defined set of button contexts for ease of dialog creation. /// /// - /// This and the Legacy Dialog are deprecated. Please migrate to the /// new Dialog. If you'd like to continue using the - /// Legacy Dialog implementation, it is recommend that the legacy code + /// Legacy Dialog implementation, it is recommended that the legacy code /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommended - /// that the application be updated to use the new Dialog system. + /// that the application be updated to use the new DialogPool system. /// [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public static class DialogButtonHelpers diff --git a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonTypes.cs b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonTypes.cs index 70b70d2a5b7..3c524773832 100644 --- a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonTypes.cs +++ b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogButtonTypes.cs @@ -9,11 +9,11 @@ namespace Microsoft.MixedReality.Toolkit.UX.Deprecated /// The style of a legacy dialog button. /// /// - /// This and the Legacy Dialog are deprecated. Please migrate to the /// new Dialog. If you'd like to continue using the - /// Legacy Dialog implementation, it is recommend that the legacy code + /// Legacy Dialog implementation, it is recommended that the legacy code /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommended - /// that the application be updated to use the new Dialog system. + /// that the application be updated to use the new DialogPool system. /// [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public enum DialogButtonType @@ -63,11 +63,11 @@ public enum DialogButtonType /// The style of a legacy dialog button. /// /// - /// This and the Legacy Dialog are deprecated. Please migrate to the /// new Dialog. If you'd like to continue using the - /// Legacy Dialog implementation, it is recommend that the legacy code + /// Legacy Dialog implementation, it is recommended that the legacy code /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommended - /// that the application be updated to use the new Dialog system. + /// that the application be updated to use the new DialogPool system. /// [Flags] [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] diff --git a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogProperty.cs b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogProperty.cs index 982b014257c..0166d6ba5a5 100644 --- a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogProperty.cs +++ b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogProperty.cs @@ -10,11 +10,11 @@ namespace Microsoft.MixedReality.Toolkit.UX.Deprecated /// Object containing properties about a dialog. /// /// - /// This and the Legacy Dialog are deprecated. Please migrate to the /// new Dialog. If you'd like to continue using the - /// Legacy Dialog implementation, it is recommend that the legacy code + /// Legacy Dialog implementation, it is recommended that the legacy code /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommended - /// that the application be updated to use the new Dialog system. + /// that the application be updated to use the new DialogPool system. /// [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public class DialogProperty diff --git a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogShell.cs b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogShell.cs index a044c5e3058..3b7b8603082 100644 --- a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogShell.cs +++ b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogShell.cs @@ -14,11 +14,11 @@ namespace Microsoft.MixedReality.Toolkit.UX.Deprecated /// If you try to open a dialog with more than two option buttons, it will show the first two. /// /// - /// This and the Legacy Dialog are deprecated. Please migrate to the /// new Dialog. If you'd like to continue using the - /// Legacy Dialog implementation, it is recommend that the legacy code + /// Legacy Dialog implementation, it is recommended that the legacy code /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommended - /// that the application be updated to use the new Dialog system. + /// that the application be updated to use the new DialogPool system. /// [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public class DialogShell : Dialog diff --git a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogState.cs b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogState.cs index 93303b17408..723b7be2d48 100644 --- a/com.microsoft.mrtk.uxcore/LegacyDialog/DialogState.cs +++ b/com.microsoft.mrtk.uxcore/LegacyDialog/DialogState.cs @@ -9,11 +9,11 @@ namespace Microsoft.MixedReality.Toolkit.UX.Deprecated /// Describes the current state of a Dialog. /// /// - /// This and the Legacy Dialog are deprecated. Please migrate to the /// new Dialog. If you'd like to continue using the - /// Legacy Dialog implementation, it is recommend that the legacy code + /// Legacy Dialog implementation, it is recommended that the legacy code /// be copied to the application's code base, and maintained independently by the application developer. Otherwise, it is strongly recommended - /// that the application be updated to use the new Dialog system. + /// that the application be updated to use the new DialogPool system. /// [Obsolete("This legacy dialog system has been deprecated. Please migrate to the new dialog system, see Microsoft.MixedReality.Toolkit.UX.DialogPool for more details.")] public enum DialogState