docs: updated docs to have consistent format

This commit is contained in:
mhartington
2016-02-22 16:20:00 -05:00
parent 01b342f7ed
commit 350a5b0911
13 changed files with 81 additions and 40 deletions
+9 -7
View File
@@ -1,6 +1,8 @@
import {Plugin, Cordova} from './plugin';
/**
* @name TouchID
* @description
* Scan the fingerprint of a user with the TouchID sensor.
*
* Requires Cordova plugin: `cordova-plugin-touch-id`. For more info, please see the [TouchID plugin docs](https://github.com/EddyVerbruggen/cordova-plugin-touch-id).
@@ -11,13 +13,13 @@ import {Plugin, Cordova} from './plugin';
*
* Here is a list of some of the error codes:
*
* `-1` - Fingerprint scan failed more than 3 times
* `-2` or `-128` - User tapped the 'Cancel' button
* `-3` - User tapped the 'Enter Passcode' or 'Enter Password' button
* `-4` - The scan was cancelled by the system (Home button for example)
* `-6` - TouchID is not Available
* `-8` - TouchID is locked out from too many tries
*
* - `-1` - Fingerprint scan failed more than 3 times
* - `-2` or `-128` - User tapped the 'Cancel' button
* - `-3` - User tapped the 'Enter Passcode' or 'Enter Password' button
* - `-4` - The scan was cancelled by the system (Home button for example)
* - `-6` - TouchID is not Available
* - `-8` - TouchID is locked out from too many tries
*
*/
@Plugin({
name: 'TouchID',