Added missing <summary> tag documentation to public MRTK3 classes and members
#11614
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
marlenaklein-msft
approved these changes
Jun 9, 2023
com.microsoft.mrtk.input/Interactors/InteractorVisuals/Lines/Definitions/InterpolationType.cs
Show resolved
Hide resolved
drusk-unity
pushed a commit
to drusk-unity/MixedRealityToolkit-Unity
that referenced
this pull request
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
AMollis
changed the title
<summary> tag documentation to public MRTK3 classes and members
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Adding in some missing documentation to the MRTK3 source.
This also replaces some
refparameters withinparameters, in cases where it was obvious that only "const refs" were needed. This also removed theInterpolationType.Hermitesince it was never handled or used.The following were documentated:
CameraSettingsclassLabelWidthAttributeclassMathExtensions.PowerOfTwoGreate=rThanOrEqualToMathExtensions.CubicToLinearIndexMathExtensions.LinearToCubicIndexMathExtensions.ClampComponentWiseRayStepstruct and some functionsStatefulInteractableclassSystemInterfaceTypeconstructorsSystemTypepublic functionsTimedFlagclass definitionUXBindingProfileTemplatepropertiesVectorExtensionssome functionsTextToSpeechSubsystem.Providerclass definitionBezierInertiaclass definition, serialized field tooltipsFuzzyGazeInteractor.GazeRaycastHitResultstruct definition and public membersHandJointInteractorpublic methodHandshapeTypesclass definitionInputActionPoseSourceserialized field tooltips.InteractionModestruct definition and serialized field tooltips and propertiesInteractionModeDefinitionserialized field tooltips and propertiesInteractionModeManagerpublic methodInterpolationTypeenum valuesMRTKHandsAggregatorSubsystem.MRTKAggregatorclass definition and public membersBugs
"MRTX/Examples/Scroll Rect Curve"#11590