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 * [camera](#module_camera) @@ -98,10 +98,8 @@ Documentation consists of template and API docs produced from the plugin JS code --- - ## camera - ### 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); ``` - ### 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) { } ``` - ### camera.onError : function Callback function that provides an error message. @@ -205,7 +201,6 @@ Callback function that provides an error message. | message | string | The message is provided by the device's native code. | - ### camera.onSuccess : function Callback function that provides the image data. @@ -225,7 +220,6 @@ function cameraCallback(imageData) { } ``` - ### camera.CameraOptions : Object Optional parameters to customize the camera settings. * [Quirks](#CameraOptions-quirks) @@ -251,10 +245,8 @@ Optional parameters to customize the camera settings. --- - ## Camera - ### Camera.DestinationType : enum **Kind**: static enum property of [Camera](#module_Camera) **Properties** @@ -266,7 +258,6 @@ Optional parameters to customize the camera settings. | NATIVE_URI | number | 2 | Return native uri (eg. asset-library://... for iOS) | - ### Camera.EncodingType : enum **Kind**: static enum property of [Camera](#module_Camera) **Properties** @@ -277,7 +268,6 @@ Optional parameters to customize the camera settings. | PNG | number | 1 | Return PNG encoded image | - ### Camera.MediaType : enum **Kind**: static enum property of [Camera](#module_Camera) **Properties** @@ -289,7 +279,6 @@ Optional parameters to customize the camera settings. | ALLMEDIA | number | 2 | Allow selection from all media types | - ### Camera.PictureSourceType : enum **Kind**: static enum property of [Camera](#module_Camera) **Properties** @@ -301,7 +290,6 @@ Optional parameters to customize the camera settings. | SAVEDPHOTOALBUM | number | 2 | Choose image from picture library (same as PHOTOLIBRARY for Android) | - ### Camera.PopoverArrowDirection : enum 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 | number | 15 | - ### Camera.Direction : enum **Kind**: static enum property of [Camera](#module_Camera) **Properties** @@ -330,7 +317,6 @@ Matches iOS UIPopoverArrowDirection constants to specify arrow location on popov --- - ## 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. --- - ## 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 element in index.html. For example, on Windows 10, you can include `ms-appdata:` in your 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 `` element in index.html. For example, on Windows 10, you can include `ms-appdata:` in your `` element. Here is an example. ```html 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 {{#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 element in index.html. For example, on Windows 10, you can include `ms-appdata:` in your 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 `` element in index.html. For example, on Windows 10, you can include `ms-appdata:` in your `` element. Here is an example. ```html