You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by an...@apache.org on 2016/09/01 13:09:53 UTC
cordova-plugin-camera git commit: CB-11661: (ios) Add mandatory iOS
10 privacy description
Repository: cordova-plugin-camera
Updated Branches:
refs/heads/master 2f89666db -> 9fe94479e
CB-11661: (ios) Add mandatory iOS 10 privacy description
This commit adds corresponding change to README template so changes from a3af38a won't be lost
Project: http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/commit/9fe94479
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/tree/9fe94479
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/diff/9fe94479
Branch: refs/heads/master
Commit: 9fe94479e257c68e56a62cbd948382c12d947abf
Parents: 2f89666
Author: Vladimir Kotikov <ko...@gmail.com>
Authored: Thu Sep 1 16:08:20 2016 +0300
Committer: Vladimir Kotikov <ko...@gmail.com>
Committed: Thu Sep 1 16:08:20 2016 +0300
----------------------------------------------------------------------
README.md | 67 +++++++++++++++++++++++++----------------------
jsdoc2md/TEMPLATE.md | 13 +++++++++
2 files changed, 48 insertions(+), 32 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/blob/9fe94479/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 9f37f9a..9b2b7a3 100644
--- a/README.md
+++ b/README.md
@@ -50,16 +50,6 @@ It is also possible to install via repo url directly ( unstable )
cordova plugin add https://github.com/apache/cordova-plugin-camera.git
-### iOS Quirks
-
-Since iOS 10 it's mandatory to add a `NSCameraUsageDescription` entry in the info.plist.
-
-`NSCameraUsageDescription` describes the reason that the app accesses the user\u2019s camera. When the system prompts the user to allow access, this string is displayed as part of the dialog box. To add this entry you can pass the variable `CAMERA_USAGE_DESCRIPTION` on plugin install.
-
-Example:
-`cordova plugin add cordova-plugin-camera --variable CAMERA_USAGE_DESCRIPTION="your usage message"`
-
-If you don't pass the variable, the plugin will add an empty string as value.
## How to Contribute
@@ -78,11 +68,24 @@ In order for your changes to be accepted, you need to sign and submit an Apache
## This documentation is generated by a tool
-:warning: Run `npm install` in the plugin repo to enable automatic docs generation if you plan to send a PR.
-[jsdoc-to-markdown](https://www.npmjs.com/package/jsdoc-to-markdown) is used to generate the docs.
+:warning: Run `npm install` in the plugin repo to enable automatic docs generation if you plan to send a PR.
+[jsdoc-to-markdown](https://www.npmjs.com/package/jsdoc-to-markdown) is used to generate the docs.
Documentation consists of template and API docs produced from the plugin JS code and should be regenerated before each commit (done automatically via [husky](https://github.com/typicode/husky), running `npm run gen-docs` script as a `precommit` hook - see `package.json` for details).
+
+### iOS Quirks
+
+Since iOS 10 it's mandatory to add a `NSCameraUsageDescription` entry in the info.plist.
+
+`NSCameraUsageDescription` describes the reason that the app accesses the user\u2019s camera. When the system prompts the user to allow access, this string is displayed as part of the dialog box. To add this entry you can pass the variable `CAMERA_USAGE_DESCRIPTION` on plugin install.
+-
+Example:
+
+ cordova plugin add cordova-plugin-camera --variable CAMERA_USAGE_DESCRIPTION="your usage message"
+
+If you don't pass the variable, the plugin will add an empty string as value.
+
---
# API Reference <a name="reference"></a>
@@ -162,7 +165,7 @@ __Supported Platforms__
More examples [here](#camera-getPicture-examples). Quirks [here](#camera-getPicture-quirks).
-**Kind**: static method of <code>[camera](#module_camera)</code>
+**Kind**: static method of <code>[camera](#module_camera)</code>
| Param | Type | Description |
| --- | --- | --- |
@@ -170,7 +173,7 @@ More examples [here](#camera-getPicture-examples). Quirks [here](#camera-getPict
| errorCallback | <code>[onError](#module_camera.onError)</code> | |
| options | <code>[CameraOptions](#module_camera.CameraOptions)</code> | CameraOptions |
-**Example**
+**Example**
```js
navigator.camera.getPicture(cameraSuccess, cameraError, cameraOptions);
```
@@ -186,8 +189,8 @@ __Supported Platforms__
- iOS
-**Kind**: static method of <code>[camera](#module_camera)</code>
-**Example**
+**Kind**: static method of <code>[camera](#module_camera)</code>
+**Example**
```js
navigator.camera.cleanup(onSuccess, onFail);
@@ -204,7 +207,7 @@ function onFail(message) {
### camera.onError : <code>function</code>
Callback function that provides an error message.
-**Kind**: static typedef of <code>[camera](#module_camera)</code>
+**Kind**: static typedef of <code>[camera](#module_camera)</code>
| Param | Type | Description |
| --- | --- | --- |
@@ -215,13 +218,13 @@ Callback function that provides an error message.
### camera.onSuccess : <code>function</code>
Callback function that provides the image data.
-**Kind**: static typedef of <code>[camera](#module_camera)</code>
+**Kind**: static typedef of <code>[camera](#module_camera)</code>
| Param | Type | Description |
| --- | --- | --- |
| imageData | <code>string</code> | Base64 encoding of the image data, _or_ the image file URI, depending on [`cameraOptions`](#module_camera.CameraOptions) in effect. |
-**Example**
+**Example**
```js
// Show image
//
@@ -236,7 +239,7 @@ function cameraCallback(imageData) {
Optional parameters to customize the camera settings.
* [Quirks](#CameraOptions-quirks)
-**Kind**: static typedef of <code>[camera](#module_camera)</code>
+**Kind**: static typedef of <code>[camera](#module_camera)</code>
**Properties**
| Name | Type | Default | Description |
@@ -268,7 +271,7 @@ _Note:_ On iOS passing `DestinationType.NATIVE_URI` along with
disable any image modifications (resize, quality change, cropping, etc.) due
to implementation specific.
-**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
+**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
**Properties**
| Name | Type | Default | Description |
@@ -280,7 +283,7 @@ to implementation specific.
<a name="module_Camera.EncodingType"></a>
### Camera.EncodingType : <code>enum</code>
-**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
+**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
**Properties**
| Name | Type | Default | Description |
@@ -291,7 +294,7 @@ to implementation specific.
<a name="module_Camera.MediaType"></a>
### Camera.MediaType : <code>enum</code>
-**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
+**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
**Properties**
| Name | Type | Default | Description |
@@ -308,7 +311,7 @@ _Note:_ On iOS passing `PictureSourceType.PHOTOLIBRARY` or `PictureSourceType.SA
along with `DestinationType.NATIVE_URI` will disable any image modifications (resize, quality
change, cropping, etc.) due to implementation specific.
-**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
+**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
**Properties**
| Name | Type | Default | Description |
@@ -322,21 +325,21 @@ change, cropping, etc.) due to implementation specific.
### Camera.PopoverArrowDirection : <code>enum</code>
Matches iOS UIPopoverArrowDirection constants to specify arrow location on popover.
-**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
+**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
**Properties**
| Name | Type | Default |
| --- | --- | --- |
-| ARROW_UP | <code>number</code> | <code>1</code> |
-| ARROW_DOWN | <code>number</code> | <code>2</code> |
-| ARROW_LEFT | <code>number</code> | <code>4</code> |
-| ARROW_RIGHT | <code>number</code> | <code>8</code> |
-| ARROW_ANY | <code>number</code> | <code>15</code> |
+| ARROW_UP | <code>number</code> | <code>1</code> |
+| ARROW_DOWN | <code>number</code> | <code>2</code> |
+| ARROW_LEFT | <code>number</code> | <code>4</code> |
+| ARROW_RIGHT | <code>number</code> | <code>8</code> |
+| ARROW_ANY | <code>number</code> | <code>15</code> |
<a name="module_Camera.Direction"></a>
### Camera.Direction : <code>enum</code>
-**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
+**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
**Properties**
| Name | Type | Default | Description |
@@ -377,7 +380,7 @@ __Supported Platforms__
- iOS
-**Example**
+**Example**
```js
navigator.camera.getPicture(onSuccess, onFail,
{
http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/blob/9fe94479/jsdoc2md/TEMPLATE.md
----------------------------------------------------------------------
diff --git a/jsdoc2md/TEMPLATE.md b/jsdoc2md/TEMPLATE.md
index 65cdbbc..696fbf5 100644
--- a/jsdoc2md/TEMPLATE.md
+++ b/jsdoc2md/TEMPLATE.md
@@ -15,6 +15,19 @@ the system's image library.
{{>cdv-header device-ready-warning-obj='navigator.camera' npmName='cordova-plugin-camera' cprName='org.apache.cordova.camera' pluginName='Plugin Camera' repoUrl='https://github.com/apache/cordova-plugin-camera' }}
+
+### iOS Quirks
+
+Since iOS 10 it's mandatory to add a `NSCameraUsageDescription` entry in the info.plist.
+
+`NSCameraUsageDescription` describes the reason that the app accesses the user\u2019s camera. When the system prompts the user to allow access, this string is displayed as part of the dialog box. To add this entry you can pass the variable `CAMERA_USAGE_DESCRIPTION` on plugin install.
+-
+Example:
+
+ cordova plugin add cordova-plugin-camera --variable CAMERA_USAGE_DESCRIPTION="your usage message"
+
+If you don't pass the variable, the plugin will add an empty string as value.
+
---
# API Reference <a name="reference"></a>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org