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/08/23 13:19:38 UTC

[1/2] cordova-plugin-camera git commit: CB-9070 Update CameraPopoverHandle docs to reflect README update

Repository: cordova-plugin-camera
Updated Branches:
  refs/heads/master 6e19147b0 -> 1beeafb6e


CB-9070 Update CameraPopoverHandle docs to reflect README update


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/7813ad9b
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/tree/7813ad9b
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/diff/7813ad9b

Branch: refs/heads/master
Commit: 7813ad9befd00b419f0caf3a6d0c0d9af87a4be5
Parents: 6e19147
Author: Vladimir Kotikov <ko...@gmail.com>
Authored: Tue Aug 23 16:14:11 2016 +0300
Committer: Vladimir Kotikov <ko...@gmail.com>
Committed: Tue Aug 23 16:16:41 2016 +0300

----------------------------------------------------------------------
 README.md                      | 20 ++++----------------
 www/Camera.js                  |  5 +----
 www/ios/CameraPopoverHandle.js | 10 ++++++++--
 3 files changed, 13 insertions(+), 22 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/blob/7813ad9b/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index c5f594b..4294bd2 100644
--- a/README.md
+++ b/README.md
@@ -93,11 +93,9 @@ Documentation consists of template and API docs produced from the plugin JS code
     * [.PictureSourceType](#module_Camera.PictureSourceType) : <code>enum</code>
     * [.PopoverArrowDirection](#module_Camera.PopoverArrowDirection) : <code>enum</code>
     * [.Direction](#module_Camera.Direction) : <code>enum</code>
-    
-* [CameraPopoverOptions](#module_CameraPopoverOptions)
 
 * [CameraPopoverHandle](#module_CameraPopoverHandle)
-	* [.setPosition(options)](#module_CameraPopoverHandle.setPosition)
+* [CameraPopoverOptions](#module_CameraPopoverOptions)
 
 ---
 
@@ -305,9 +303,9 @@ change, cropping, etc.) due to implementation specific.
 
 | Name | Type | Default | Description |
 | --- | --- | --- | --- |
-| PHOTOLIBRARY | <code>number</code> | <code>0</code> | Choose image from the device's photo library (same as SAVEDPHOTOALBUM for Android) |
+| PHOTOLIBRARY | <code>number</code> | <code>0</code> | Choose image from picture library (same as SAVEDPHOTOALBUM for Android) |
 | CAMERA | <code>number</code> | <code>1</code> | Take picture from camera |
-| SAVEDPHOTOALBUM | <code>number</code> | <code>2</code> | Choose image only from the device's Camera Roll album (same as PHOTOLIBRARY for Android) |
+| SAVEDPHOTOALBUM | <code>number</code> | <code>2</code> | Choose image from picture library (same as PHOTOLIBRARY for Android) |
 
 <a name="module_Camera.PopoverArrowDirection"></a>
 
@@ -363,17 +361,7 @@ location.
 <a name="module_CameraPopoverHandle"></a>
 
 ## CameraPopoverHandle
-A handle to the image picker popover.
-
-<a name="module_CameraPopoverHandle.setPosition"></a>
-
-### CameraPopoverHandle.setPosition(options)
-Can be used to reposition the image selection dialog, for example, when the device orientation changes.
-
-
-| Param | Type | Description |
-| --- | --- | --- |
-| options | <code>[CameraPopoverOptions](#module_CameraPopoverOptions)</code> | CameraPopoverOptions |
+A handle to an image picker popover.
 
 __Supported Platforms__
 

http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/blob/7813ad9b/www/Camera.js
----------------------------------------------------------------------
diff --git a/www/Camera.js b/www/Camera.js
index 04d13d9..d006787 100644
--- a/www/Camera.js
+++ b/www/Camera.js
@@ -89,10 +89,7 @@ for (var key in Camera) {
  *
  * If `Camera.sourceType` is `Camera.PictureSourceType.PHOTOLIBRARY` or
  * `Camera.PictureSourceType.SAVEDPHOTOALBUM`, then a dialog displays
- * that allows users to select an existing image.  The
- * `camera.getPicture` function returns a [`CameraPopoverHandle`]{@link module:CameraPopoverHandle} object,
- * which can be used to reposition the image selection dialog, for
- * example, when the device orientation changes.
+ * that allows users to select an existing image.
  *
  * The return value is sent to the [`cameraSuccess`]{@link module:camera.onSuccess} callback function, in
  * one of the following formats, depending on the specified

http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/blob/7813ad9b/www/ios/CameraPopoverHandle.js
----------------------------------------------------------------------
diff --git a/www/ios/CameraPopoverHandle.js b/www/ios/CameraPopoverHandle.js
index 3990e18..8b92137 100644
--- a/www/ios/CameraPopoverHandle.js
+++ b/www/ios/CameraPopoverHandle.js
@@ -33,7 +33,7 @@ var exec = require('cordova/exec');
  * - iOS
  *
  * @example
- * var cameraPopoverHandle = navigator.camera.getPicture(onSuccess, onFail,
+ * navigator.camera.getPicture(onSuccess, onFail,
  * {
  *     destinationType: Camera.DestinationType.FILE_URI,
  *     sourceType: Camera.PictureSourceType.PHOTOLIBRARY,
@@ -42,13 +42,19 @@ var exec = require('cordova/exec');
  *
  * // Reposition the popover if the orientation changes.
  * window.onorientationchange = function() {
+ *     var cameraPopoverHandle = new CameraPopoverHandle();
  *     var cameraPopoverOptions = new CameraPopoverOptions(0, 0, 100, 100, Camera.PopoverArrowDirection.ARROW_ANY);
  *     cameraPopoverHandle.setPosition(cameraPopoverOptions);
  * }
  * @module CameraPopoverHandle
  */
 var CameraPopoverHandle = function() {
-    /** Set the position of the popover.
+    /**
+     * Can be used to reposition the image selection dialog,
+     * for example, when the device orientation changes.
+     * @memberof CameraPopoverHandle
+     * @instance
+     * @method setPosition
      * @param {module:CameraPopoverOptions} popoverOptions
      */
     this.setPosition = function(popoverOptions) {


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org


[2/2] cordova-plugin-camera git commit: CB-10067 Update PictureSourceType JSDoc to reflect README update

Posted by an...@apache.org.
CB-10067 Update PictureSourceType JSDoc to reflect README update


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/1beeafb6
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/tree/1beeafb6
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/diff/1beeafb6

Branch: refs/heads/master
Commit: 1beeafb6e8b2296d7748d545128686bf8296bbb7
Parents: 7813ad9
Author: Vladimir Kotikov <ko...@gmail.com>
Authored: Tue Aug 23 16:14:59 2016 +0300
Committer: Vladimir Kotikov <ko...@gmail.com>
Committed: Tue Aug 23 16:18:00 2016 +0300

----------------------------------------------------------------------
 README.md              | 4 ++--
 www/CameraConstants.js | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/blob/1beeafb6/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 4294bd2..fef0049 100644
--- a/README.md
+++ b/README.md
@@ -303,9 +303,9 @@ change, cropping, etc.) due to implementation specific.
 
 | Name | Type | Default | Description |
 | --- | --- | --- | --- |
-| PHOTOLIBRARY | <code>number</code> | <code>0</code> | Choose image from picture library (same as SAVEDPHOTOALBUM for Android) |
+| PHOTOLIBRARY | <code>number</code> | <code>0</code> | Choose image from the device's photo library (same as SAVEDPHOTOALBUM for Android) |
 | CAMERA | <code>number</code> | <code>1</code> | Take picture from camera |
-| SAVEDPHOTOALBUM | <code>number</code> | <code>2</code> | Choose image from picture library (same as PHOTOLIBRARY for Android) |
+| SAVEDPHOTOALBUM | <code>number</code> | <code>2</code> | Choose image only from the device's Camera Roll album (same as PHOTOLIBRARY for Android) |
 
 <a name="module_Camera.PopoverArrowDirection"></a>
 

http://git-wip-us.apache.org/repos/asf/cordova-plugin-camera/blob/1beeafb6/www/CameraConstants.js
----------------------------------------------------------------------
diff --git a/www/CameraConstants.js b/www/CameraConstants.js
index c13dba3..9974c15 100644
--- a/www/CameraConstants.js
+++ b/www/CameraConstants.js
@@ -71,11 +71,11 @@ module.exports = {
    * @enum {number}
    */
   PictureSourceType:{
-    /** Choose image from picture library (same as SAVEDPHOTOALBUM for Android) */
+    /** Choose image from the device's photo library (same as SAVEDPHOTOALBUM for Android) */
     PHOTOLIBRARY : 0,
     /** Take picture from camera */
     CAMERA : 1,
-    /** Choose image from picture library (same as PHOTOLIBRARY for Android) */
+    /** Choose image only from the device's Camera Roll album (same as PHOTOLIBRARY for Android) */
     SAVEDPHOTOALBUM : 2
   },
   /**


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org