-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
Comments
24 tasks
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
21 tasks
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
47 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
classLabelWidthAttribute
classMathExtensions.PowerOfTwoGreate=rThanOrEqualTo
MathExtensions.CubicToLinearIndex
MathExtensions.LinearToCubicIndex
MathExtensions.ClampComponentWise
RayStep
struct and some functionsStatefulInteractable
classSystemInterfaceType
constructorsSystemType
public functionsTimedFlag
class definitionUXBindingProfileTemplate
propertiesVectorExtensions
some functionsTextToSpeechSubsystem.Provider
class definitionBezierInertia
class definition, serialized field tooltipsFuzzyGazeInteractor.GazeRaycastHitResult
struct definition and public membersHandJointInteractor
public methodHandshapeTypes
class definitionInputActionPoseSource
serialized field tooltips.InteractionMode
struct definition and serialized field tooltips and propertiesInteractionModeDefinition
serialized field tooltips and propertiesInteractionModeManager
public methodInterpolationType
enum valuesMRTKHandsAggregatorSubsystem.MRTKAggregator
class definition and public membersRound Three
SyntheticHandsConfig
class definitionSyntheticHandsSubsystem
class definitionControllerSimulationSettings
some public propertiesMRTKRayReticleVisual.ReticleVisibilitySettings
enum definition and enum valuesSpatialManipulation.FixedDistanceConstraint
SpatialManipulation.FixedRotationToUserConstraint
SpatialManipulation.FixedRotationToWorldConstraint
SpatialManipulation.MaintainApparentSizeConstraint
SpatialManipulation.MoveAxisConstraint
WindowsDictationSubsystem
class definitionWindowsDictationSubsystemConfig
class definitionWindowsKeywordRecognitionSubsystem
class definitionWindowsKeywordRecognitionSubsystemConfig
class definitionWindowsTextToSpeechSubsystem
class definitionBasicPressableButtonVisuals
serializable fields, public properties, and protected functionCanvasProxyInteractor
projected fieldsDialogButtonType
enum valuesDialogDismissedEventArgs
class definitionObjectBarFlowDirection
enum valuesPressableButton.SpaceMode
enum valuesToggleSelectedEvent
class definitionThe text was updated successfully, but these errors were encountered: