From 80e679f4dcf5871213aa2dd19b6f08178598c306 Mon Sep 17 00:00:00 2001 From: Aaron Czichon Date: Sun, 12 Jun 2016 15:25:22 +0200 Subject: [PATCH] Improved brightness plugin documentation --- src/plugins/brightness.ts | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/src/plugins/brightness.ts b/src/plugins/brightness.ts index fc71b9344..2fc29d992 100644 --- a/src/plugins/brightness.ts +++ b/src/plugins/brightness.ts @@ -1,5 +1,21 @@ import {Plugin, Cordova} from './plugin'; +/** + * @name Brightness + * @description + * The Brightness plugin let you control the display brightness of your device. + * + * Requires Cordova plugin: `cordova-plugin-brightness`. For more info, please see the [Brightness plugin docs](https://github.com/mgcrea/cordova-plugin-brightness). + * + * @usage + * ```ts + * import {Brightness} from 'ionic-native'; + * + * let brightnessValue: number = 0.8; + * Brightness.setBrightness(brightnessValue); + * ``` + * + */ @Plugin({ plugin: 'cordova-plugin-brightness', pluginRef: 'plugins.brightness',