Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

For MRTK3 GA, add comment blocks for API reference docs #11596

Closed
47 tasks done
AMollis opened this issue May 31, 2023 · 0 comments
Closed
47 tasks done

For MRTK3 GA, add comment blocks for API reference docs #11596

AMollis opened this issue May 31, 2023 · 0 comments

Comments

@AMollis
Copy link
Member

AMollis commented May 31, 2023

This issue has been migrated a new MRTK repository, and the status of this issue will now be tracked at the following location:


Overview

Various public and protected MRTK3 classes, functions, properties, and events are missing documentation <summary> blocks. These need to be added. Microsoft uses these summaries to generate API reference documents.

Parent Task

Tasks

Add Comment Blocks for API Reference Docs (GA)

Round One

  • SpatialManipulation.ObjectManipulator.GetReferenceFrameTransform
  • SpatialManipulation.ScaleAnchorType

Round Two

  • CameraSettings class
  • LabelWidthAttribute class
  • MathExtensions.PowerOfTwoGreate=rThanOrEqualTo
  • MathExtensions.CubicToLinearIndex
  • MathExtensions.LinearToCubicIndex
  • MathExtensions.ClampComponentWise
  • RayStep struct and some functions
  • StatefulInteractable class
  • SystemInterfaceType constructors
  • SystemType public functions
  • TimedFlag class definition
  • UXBindingProfileTemplate properties
  • VectorExtensions some functions
  • TextToSpeechSubsystem.Provider class definition
  • BezierInertia class definition, serialized field tooltips
  • FuzzyGazeInteractor.GazeRaycastHitResult struct definition and public members
  • HandJointInteractor public method
  • HandshapeTypes class definition
  • InputActionPoseSource serialized field tooltips.
  • InteractionMode struct definition and serialized field tooltips and properties
  • InteractionModeDefinition serialized field tooltips and properties
  • InteractionModeManager public method
  • InterpolationType enum values
  • MRTKHandsAggregatorSubsystem.MRTKAggregator class definition and public members

Round Three

  • SyntheticHandsConfig class definition
  • SyntheticHandsSubsystem class definition
  • ControllerSimulationSettings some public properties
  • MRTKRayReticleVisual.ReticleVisibilitySettings enum definition and enum values
  • SpatialManipulation.FixedDistanceConstraint
  • SpatialManipulation.FixedRotationToUserConstraint
  • SpatialManipulation.FixedRotationToWorldConstraint
  • SpatialManipulation.MaintainApparentSizeConstraint
  • SpatialManipulation.MoveAxisConstraint
  • WindowsDictationSubsystem class definition
  • WindowsDictationSubsystemConfig class definition
  • WindowsKeywordRecognitionSubsystem class definition
  • WindowsKeywordRecognitionSubsystemConfig class definition
  • WindowsTextToSpeechSubsystem class definition
  • BasicPressableButtonVisuals serializable fields, public properties, and protected function
  • CanvasProxyInteractor projected fields
  • DialogButtonType enum values
  • DialogDismissedEventArgs class definition
  • ObjectBarFlowDirection enum values
  • PressableButton.SpaceMode enum values
  • ToggleSelectedEvent class definition
@github-actions github-actions bot added the MRTK3 label May 31, 2023
@AMollis AMollis added this to the MRTK v3.0 GA milestone May 31, 2023
AMollis added a commit that referenced this issue Jun 10, 2023
Adding in some missing documentation to the MRTK3 source.  

This also replaces some `ref` parameters with `in` parameters, in cases where it was obvious that only "const refs" were needed.  This also removed the `InterpolationType.Hermite` since it was never handled or used.

The following were documentated:
  - [x] `CameraSettings` class
  - [x] `LabelWidthAttribute` class
  - [x] `MathExtensions.PowerOfTwoGreate=rThanOrEqualTo`
  - [x] `MathExtensions.CubicToLinearIndex`
  - [x] `MathExtensions.LinearToCubicIndex`
  - [x] `MathExtensions.ClampComponentWise`
  - [x] `RayStep` struct and some functions
  - [x] `StatefulInteractable` class
  - [x] `SystemInterfaceType` constructors
  - [x] `SystemType` public functions
  - [x] `TimedFlag` class definition
  - [x] `UXBindingProfileTemplate` properties
  - [x] `VectorExtensions` some functions
  - [x] `TextToSpeechSubsystem.Provider` class definition
  - [x] `BezierInertia` class definition, serialized field tooltips
  - [x] `FuzzyGazeInteractor.GazeRaycastHitResult` struct definition and public members
  - [x] `HandJointInteractor` public method
  - [x] `HandshapeTypes` class definition
  - [x] `InputActionPoseSource` serialized field tooltips.
  - [x] `InteractionMode` struct definition and serialized field tooltips and properties
  - [x] `InteractionModeDefinition` serialized field tooltips and properties
  - [x] `InteractionModeManager` public method
  - [x] `InterpolationType` enum values
  - [x] `MRTKHandsAggregatorSubsystem.MRTKAggregator` class definition and public members

## Bugs
- #11596
- #1159
@AMollis AMollis assigned AMollis and unassigned shaynie Jun 12, 2023
@AMollis AMollis closed this as completed Jun 19, 2023
drusk-unity pushed a commit to drusk-unity/MixedRealityToolkit-Unity that referenced this issue Jun 26, 2023
…11614)

Adding in some missing documentation to the MRTK3 source.  

This also replaces some `ref` parameters with `in` parameters, in cases where it was obvious that only "const refs" were needed.  This also removed the `InterpolationType.Hermite` since it was never handled or used.

The following were documentated:
  - [x] `CameraSettings` class
  - [x] `LabelWidthAttribute` class
  - [x] `MathExtensions.PowerOfTwoGreate=rThanOrEqualTo`
  - [x] `MathExtensions.CubicToLinearIndex`
  - [x] `MathExtensions.LinearToCubicIndex`
  - [x] `MathExtensions.ClampComponentWise`
  - [x] `RayStep` struct and some functions
  - [x] `StatefulInteractable` class
  - [x] `SystemInterfaceType` constructors
  - [x] `SystemType` public functions
  - [x] `TimedFlag` class definition
  - [x] `UXBindingProfileTemplate` properties
  - [x] `VectorExtensions` some functions
  - [x] `TextToSpeechSubsystem.Provider` class definition
  - [x] `BezierInertia` class definition, serialized field tooltips
  - [x] `FuzzyGazeInteractor.GazeRaycastHitResult` struct definition and public members
  - [x] `HandJointInteractor` public method
  - [x] `HandshapeTypes` class definition
  - [x] `InputActionPoseSource` serialized field tooltips.
  - [x] `InteractionMode` struct definition and serialized field tooltips and properties
  - [x] `InteractionModeDefinition` serialized field tooltips and properties
  - [x] `InteractionModeManager` public method
  - [x] `InterpolationType` enum values
  - [x] `MRTKHandsAggregatorSubsystem.MRTKAggregator` class definition and public members

## Bugs
- microsoft#11596
- microsoft#1159
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants