search

project-chip / connectedhomeip

Matter (formerly Project CHIP) creates more connections between more objects, simplifying development for manufacturers and increasing compatibility for consumers, guided by the Connectivity Standards Alliance.
https://buildwithmatter.com
Apache License 2.0
7.5k stars 2.01k forks source link

[Documentation] Missing Documentation for iOS Methods in Matter SDK #29671

Open mukesh-simform opened 1 year ago

mukesh-simform commented 1 year ago

Documentation issues

I have noticed that there is a lack of documentation for the Android and iOS methods in the Matter SDK. This gap in documentation is making it challenging for developers to effectively use the SDK for mobile app development

e.g For Android: pairDevice, pairDeviceWithCode, pairDeviceWithAddress, writeBindingAttribute, readBindingAttribute, readAclAttribute etc

Platform

android, darwin

Anything else?

There is currently no documentation available for Android and iOS methods in the Matter SDK, which makes it difficult for developers to implement these methods correctly

There should be comprehensive documentation for Android and iOS methods in the Matter SDK, including clear explanations of the methods' functionality, parameters, and usage examples

yunhanw-google commented 1 year ago

Android document is tracked under https://github.com/project-chip/connectedhomeip/issues/29292, thanks