MRTK3 API Review for Post General Availability

[AMollis]

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

• MRTK3 API Review for Post General Availability MixedRealityToolkit/MixedRealityToolkit-Unity#108

---

Post GA Changes

These changes should be considered post MRTK3 GA

Post GA Packages

• com.microsoft.mrtk.accessibility
• com.microsoft.mrtk.data
• com.microsoft.mrtk.diagnostics

Build Pipeline

• Possibly an API surface checker. Port the API surface checking tools from the OpenXR repo

Review Public APIs (Post-GA)

• Consider renaming DataBindingConfigurator as Configurator is not a word.
• Refactor DataKeyPathMapperGODictionary to use SerializableDictionary once core utilities are separable.
• Rename the classes with GO abbreviation, so to remove the abbreviation
  • DataSourceGOBase
  • DataConsumerGOBase
  • DataControllerGOBase
  • DataKeyPathMapperGODictionary
  • DataCollectionEventsGOBase
  • DataCollectionItemPlacerGOBase
  • DataSourceGOJson
• Rename protected fields that start with _, and then make public and protected fields properties
  • DataSourceDictionary._XXXX
  • DataSourceBase._XXXX
  • DataConsumerGOBase._XXXX
  • DataConsumerSpriteLookup._XXXX
  • DataConsumerCollection._XXXX
  • DataConsumerThemableBase._XXXX
  • DataKeyPathMapperDictionary._XXXX
  • DataNodeObject._XXXX
  • DataObjectPool._XXXX
  • DataKeyPathMapperGODictionary._XXXX
  • DataConsumerImageTextureFromUrl._XXXX
  • DataSourceGOJson._XXXX
  • DataSourceJson._XXXX
  • DataSourceObjects._XXXX
  • DataSourceProviderSingleton._XXXX
  • DataSourceReflection._XXXX
  • KeyPathEnumerable._XXXX
  • DataSourceReflection.LRUItem.XXXX

Add missing sections to overview docs (Post-GA)

• Update accessibility overview
  • Add a how-to use AccessibilitySubsystem
  • Change DescribableObject to AccessibleObject, update image, and update property names in document
• Overview documentation for Data packages
  • Add an overview for data collections, including DataCollectionItemPlacerOffset
  • Information about DataConsumerAudioClip
  • Information about DataConsumerBooleanEvents
  • Information about DataConsumerCommandDispatcher
  • Information about DataConsumerImageTextureFromUrl and subclasses
  • More information about DataConsumerThemableBase subclasses
  • Information about DataConsumerSpriteLookup
  • Information about DataControllerGOBase
  • Information about IDataKeyPathMapper implementations
  • Information about using structured data with DataSourceObjects, DataNodeObject

Add Comment Blocks for API Reference Docs (Post GA)

• DataBindingConfigurator constructors
• DataChangeType enum values
• DataCollectionItemPlacerGOBase protected function, enum, and classes
• DataConsumerBooleanEvents protected classes and functions
• DataConsumerCollection protected functions
• DataConsumerGOBase public and protected members
• DataConsumerImageTextureFromUrl public and protected members
• DataConsumerMaterial class definition
• DataConsumerText public and protected members
• DataConsumerThemableBase and DataConsumerThemableBase<T> public and protected members
• DataConsumerThemableBase.BindingInfo public and protected members
• DataConsumerThemeHelper public and protected members
• DataKeyPathMapperDictionary protected members
• DataKeyPathMapperGODictionary public and protected members
• DataKeyPathMapperGODictionary.ViewToDataKeypathMap
• DataNodeObject public and protected members
• DataNodeType enum values
• DataObjectPool public and protected members
• DataObjectPool.LRUIndexList
• DataSourceBase public and protected members
• DataSourceDictionary protected members
• DataSourceGODictionary public delegate
• DataSourceGODictionary.KeyPathValue class definition
• DataSourceGOJson public and protected members
• DataSourceGOJson.RequestFailureDelegate delegate
• DataSourceGOJson.RequestSuccessDelegate delegate
• DataSourceJson public and protected members
• DataSourceObjects constructor, public and protected members
• DataSourceProviderSingleton protected members
• DataSourceReflection constructors, public and protected members
• DataSourceReflection.CollectionObserver constructors and protected members
• DataSourceReflection.LRUItem public members
• DataSourceThemeProvider public and protected members
• IDataConsumerThemable definition
• KeyPathEnumerable protected members
• LeastRecentlyUsedCache class definitions, public members
• LeastRecentlyUsedCache.LRUValue<KT> definitions
• ThemeSelector definitions and public property
• UXThemeProfile public properties
• ButtonTheme public properties
• CommonTheme definition, serializable fields tooltips, public properties
• DialogTheme public properties
• HandMenuTheme public properties
• ListMenuTheme public properties
• SlateTheme public properties
• SliderTheme public properties
• SpriteSetTheme public properties
• ToggleTheme public properties
• ToggleTheme public properties
• ToggleTheme public properties