teslamotors / react-native-camera-kit

A high performance, easy to use, rock solid camera library for React Native apps.
MIT License
2.46k stars 585 forks source link

Update RNCameraKitModule.kt with KDoc #575

Closed dhiasaadlaui closed 11 months ago

dhiasaadlaui commented 1 year ago

This commit adds detailed Kotlin Documentation (KDoc) to the RNCameraKitModule and BarcodeFrame classes, enhancing code clarity and providing comprehensive explanations for their methods and functionality.

For the RNCameraKitModule class, the KDoc comments provide an in-depth understanding of its purpose, methods, and constants. Additionally, the capture method documentation offers insights into how it's used to capture photos using the camera.

In the BarcodeFrame class, the KDoc comments thoroughly explain the purpose and behavior of the class, as well as the functionality of methods such as setFrameColor and drawLaser.

I would like to keep working on the rest of classes to provide a comprehensive explanations on every method

scarlac commented 11 months ago

Thanks @dhiasaadlaui