You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ra...@apache.org on 2016/05/17 17:59:23 UTC
cordova-plugin-camera git commit: fixed some bad formatting that hid
HTML tags and added link to sample
Repository: cordova-plugin-camera
Updated Branches:
refs/heads/master 3586ea58a -> a831e15a9
fixed some bad formatting that hid HTML tags and added link to sample
This closes #207
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/a831e15a
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/tree/a831e15a
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/diff/a831e15a
Branch: refs/heads/master
Commit: a831e15a917eb8666be91e23869e7fb0263e5782
Parents: 3586ea5
Author: Mikejo5001 <m....@outlook.com>
Authored: Tue Apr 26 13:30:38 2016 -0700
Committer: Raghav Katyal <ra...@microsoft.com>
Committed: Tue May 17 10:58:26 2016 -0700
----------------------------------------------------------------------
README.md | 19 ++-----------------
jsdoc2md/TEMPLATE.md | 4 ++--
2 files changed, 4 insertions(+), 19 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/blob/a831e15a/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 8102670..7f5a9cf 100644
--- a/README.md
+++ b/README.md
@@ -73,7 +73,7 @@ Documentation consists of template and API docs produced from the plugin JS code
---
-# API Reference
+# API Reference <a name="reference"></a>
* [camera](#module_camera)
@@ -98,10 +98,8 @@ Documentation consists of template and API docs produced from the plugin JS code
---
<a name="module_camera"></a>
-
## camera
<a name="module_camera.getPicture"></a>
-
### camera.getPicture(successCallback, errorCallback, options)
Takes a photo using the camera, or retrieves a photo from the device's
image gallery. The image is passed to the success callback as a
@@ -169,7 +167,6 @@ More examples [here](#camera-getPicture-examples). Quirks [here](#camera-getPict
navigator.camera.getPicture(cameraSuccess, cameraError, cameraOptions);
```
<a name="module_camera.cleanup"></a>
-
### camera.cleanup()
Removes intermediate image files that are kept in temporary storage
after calling [`camera.getPicture`](#module_camera.getPicture). Applies only when the value of
@@ -194,7 +191,6 @@ function onFail(message) {
}
```
<a name="module_camera.onError"></a>
-
### camera.onError : <code>function</code>
Callback function that provides an error message.
@@ -205,7 +201,6 @@ Callback function that provides an error message.
| message | <code>string</code> | The message is provided by the device's native code. |
<a name="module_camera.onSuccess"></a>
-
### camera.onSuccess : <code>function</code>
Callback function that provides the image data.
@@ -225,7 +220,6 @@ function cameraCallback(imageData) {
}
```
<a name="module_camera.CameraOptions"></a>
-
### camera.CameraOptions : <code>Object</code>
Optional parameters to customize the camera settings.
* [Quirks](#CameraOptions-quirks)
@@ -251,10 +245,8 @@ Optional parameters to customize the camera settings.
---
<a name="module_Camera"></a>
-
## Camera
<a name="module_Camera.DestinationType"></a>
-
### Camera.DestinationType : <code>enum</code>
**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
**Properties**
@@ -266,7 +258,6 @@ Optional parameters to customize the camera settings.
| NATIVE_URI | <code>number</code> | <code>2</code> | Return native uri (eg. asset-library://... for iOS) |
<a name="module_Camera.EncodingType"></a>
-
### Camera.EncodingType : <code>enum</code>
**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
**Properties**
@@ -277,7 +268,6 @@ Optional parameters to customize the camera settings.
| PNG | <code>number</code> | <code>1</code> | Return PNG encoded image |
<a name="module_Camera.MediaType"></a>
-
### Camera.MediaType : <code>enum</code>
**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
**Properties**
@@ -289,7 +279,6 @@ Optional parameters to customize the camera settings.
| ALLMEDIA | <code>number</code> | <code>2</code> | Allow selection from all media types |
<a name="module_Camera.PictureSourceType"></a>
-
### Camera.PictureSourceType : <code>enum</code>
**Kind**: static enum property of <code>[Camera](#module_Camera)</code>
**Properties**
@@ -301,7 +290,6 @@ Optional parameters to customize the camera settings.
| SAVEDPHOTOALBUM | <code>number</code> | <code>2</code> | Choose image from picture library (same as PHOTOLIBRARY for Android) |
<a name="module_Camera.PopoverArrowDirection"></a>
-
### Camera.PopoverArrowDirection : <code>enum</code>
Matches iOS UIPopoverArrowDirection constants to specify arrow location on popover.
@@ -317,7 +305,6 @@ Matches iOS UIPopoverArrowDirection constants to specify arrow location on popov
| 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>
**Properties**
@@ -330,7 +317,6 @@ Matches iOS UIPopoverArrowDirection constants to specify arrow location on popov
---
<a name="module_CameraPopoverOptions"></a>
-
## CameraPopoverOptions
iOS-only parameters that specify the anchor element location and arrow
direction of the popover when selecting images from an iPad's library
@@ -352,7 +338,6 @@ location.
---
<a name="module_CameraPopoverHandle"></a>
-
## CameraPopoverHandle
A handle to an image picker popover.
@@ -618,7 +603,7 @@ function displayImage(imgUri) {
}
```
-To display the image on some platforms, you might need to include the main part of the URI in the Content-Security-Policy <meta> element in index.html. For example, on Windows 10, you can include `ms-appdata:` in your <meta> element. Here is an example.
+To display the image on some platforms, you might need to include the main part of the URI in the Content-Security-Policy `<meta>` element in index.html. For example, on Windows 10, you can include `ms-appdata:` in your `<meta>` element. Here is an example.
```html
<meta http-equiv="Content-Security-Policy" content="default-src 'self' data: gap: ms-appdata: https://ssl.gstatic.com 'unsafe-eval'; style-src 'self' 'unsafe-inline'; media-src *">
http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/blob/a831e15a/jsdoc2md/TEMPLATE.md
----------------------------------------------------------------------
diff --git a/jsdoc2md/TEMPLATE.md b/jsdoc2md/TEMPLATE.md
index d554107..64bce32 100644
--- a/jsdoc2md/TEMPLATE.md
+++ b/jsdoc2md/TEMPLATE.md
@@ -15,7 +15,7 @@ the system's image library.
---
-# API Reference
+# API Reference <a name="reference"></a>
{{#orphans~}}
{{>member-index}}
@@ -274,7 +274,7 @@ function displayImage(imgUri) {
}
```
-To display the image on some platforms, you might need to include the main part of the URI in the Content-Security-Policy <meta> element in index.html. For example, on Windows 10, you can include `ms-appdata:` in your <meta> element. Here is an example.
+To display the image on some platforms, you might need to include the main part of the URI in the Content-Security-Policy `<meta>` element in index.html. For example, on Windows 10, you can include `ms-appdata:` in your `<meta>` element. Here is an example.
```html
<meta http-equiv="Content-Security-Policy" content="default-src 'self' data: gap: ms-appdata: https://ssl.gstatic.com 'unsafe-eval'; style-src 'self' 'unsafe-inline'; media-src *">
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org