You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/06/12 19:51:01 UTC
[26/46] docs commit: edits mostly in globalization
edits mostly in globalization
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/d9648d01
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/d9648d01
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/d9648d01
Branch: refs/heads/master
Commit: d9648d0193d8319ccadb22422e1b8003dab32471
Parents: 80d6aea
Author: Mike Sierra <le...@gmail.com>
Authored: Thu May 16 18:08:40 2013 -0400
Committer: Mike Sierra <le...@gmail.com>
Committed: Thu May 16 18:08:40 2013 -0400
----------------------------------------------------------------------
.../globalization/globalization.dateToString.md | 14 +++++++++-----
.../globalization/globalization.getDateNames.md | 2 +-
.../globalization/globalization.getFirstDayOfWeek.md | 2 +-
.../globalization/globalization.getLocaleName.md | 2 +-
.../globalization.getPreferredLanguage.md | 2 +-
.../globalization.isDayLightSavingsTime.md | 2 +-
.../globalization/globalization.numberToString.md | 2 +-
.../globalization/globalization.stringToNumber.md | 2 +-
docs/en/edge/cordova/media/capture/capture.md | 2 +-
docs/en/edge/cordova/media/capture/captureAudio.md | 2 +-
10 files changed, 18 insertions(+), 14 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d9648d01/docs/en/edge/cordova/globalization/globalization.dateToString.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.dateToString.md b/docs/en/edge/cordova/globalization/globalization.dateToString.md
index f748b37..80192ea 100644
--- a/docs/en/edge/cordova/globalization/globalization.dateToString.md
+++ b/docs/en/edge/cordova/globalization/globalization.dateToString.md
@@ -27,14 +27,18 @@ Returns a date formatted as a string according to the client's locale and timezo
Description
-----------
-It returns the formatted date string to the successCB callback with a properties object as a parameter. That object should have a ``value`` property with a String value.
+It returns the formatted date string to the successCB callback with a
+properties object as a parameter. That object should have a `value`
+property with a `String` value.
-The inbound ``date`` parameter should be of type ``Date``.
+The inbound `date` parameter should be of type `Date`.
-If there is an error formatting the date, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING\_ERROR.
+If there is an error formatting the date, then the `errorCB` callback is
+invoked with a `GlobalizationError` object as a parameter. The expected
+code for this error is `GlobalizationError.FORMATTING\_ERROR`.
-`options.formatLength` can be 'short', 'medium', 'long', or 'full'.
-`options.selector` can be 'date', 'time' or 'date and time'.
+The `options.formatLength` can be 'short', 'medium', 'long', or 'full'.
+The `options.selector` can be 'date', 'time' or 'date and time'.
The default options are `{formatLength:'short', selector:'date and time'}`.
The `options` parameter is optional.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d9648d01/docs/en/edge/cordova/globalization/globalization.getDateNames.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getDateNames.md b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
index 92863cd..aa6f89a 100644
--- a/docs/en/edge/cordova/globalization/globalization.getDateNames.md
+++ b/docs/en/edge/cordova/globalization/globalization.getDateNames.md
@@ -27,7 +27,7 @@ Returns an array of either the names of the months or days of the week according
Description
-----------
-It returns the array of names to the successCB callback with a properties object as a parameter. That object should have a ``value`` property with an Array of Strings. That array will be the names starting from either the first month in the year or the first day of the week, depending on the option selected.
+It returns the array of names to the successCB callback with a properties object as a parameter. That object should have a `value` property with an Array of Strings. That array will be the names starting from either the first month in the year or the first day of the week, depending on the option selected.
If there is an error obtaining the names, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d9648d01/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
index ea2e0da..15f02e0 100644
--- a/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
+++ b/docs/en/edge/cordova/globalization/globalization.getFirstDayOfWeek.md
@@ -27,7 +27,7 @@ Returns the first day of the week according to the client's user preferences and
Description
-----------
-The days of the week are numbered starting from 1 where 1 is considered to be Sunday. It returns the day to the successCB callback with a properties object as a parameter. That object should have a ``value`` property with a Number value.
+The days of the week are numbered starting from 1 where 1 is considered to be Sunday. It returns the day to the successCB callback with a properties object as a parameter. That object should have a `value` property with a Number value.
If there is an error obtaining the pattern, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d9648d01/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
index 4a30024..d07939a 100644
--- a/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
+++ b/docs/en/edge/cordova/globalization/globalization.getLocaleName.md
@@ -29,7 +29,7 @@ Description
-----------
It returns the locale identifier string to the successCB callback with a
-properties object as a parameter. That object should have a ``value`` property with a String value.
+properties object as a parameter. That object should have a `value` property with a String value.
If there is an error getting the locale, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d9648d01/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
index 6ffb40d..8110432 100644
--- a/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
+++ b/docs/en/edge/cordova/globalization/globalization.getPreferredLanguage.md
@@ -29,7 +29,7 @@ Description
-----------
It returns the language identifier string to the successCB callback with a
-properties object as a parameter. That object should have a ``value`` property with a String value.
+properties object as a parameter. That object should have a `value` property with a String value.
If there is an error getting the language, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN\_ERROR.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d9648d01/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md b/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
index 2ecf085..537339d 100644
--- a/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
+++ b/docs/en/edge/cordova/globalization/globalization.isDayLightSavingsTime.md
@@ -27,7 +27,7 @@ Returns whether daylight savings time is in effect for a given date using the cl
Description
-----------
-It returns whether or not daylight savings time is in effect to the successCB callback with a properties object as a parameter. That object should have a ``dst`` property with a Boolean value. The value 'true' indicates that daylight savings time is in effect for the given date, and 'false' indicates that it is not.
+It returns whether or not daylight savings time is in effect to the successCB callback with a properties object as a parameter. That object should have a `dst` property with a Boolean value. The value 'true' indicates that daylight savings time is in effect for the given date, and 'false' indicates that it is not.
The inbound parameter `date` should be of type `Date`.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d9648d01/docs/en/edge/cordova/globalization/globalization.numberToString.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.numberToString.md b/docs/en/edge/cordova/globalization/globalization.numberToString.md
index 51e8cff..c0c9e48 100644
--- a/docs/en/edge/cordova/globalization/globalization.numberToString.md
+++ b/docs/en/edge/cordova/globalization/globalization.numberToString.md
@@ -27,7 +27,7 @@ Returns a number formatted as a string according to the client's user preference
Description
-----------
-It returns the formatted number string to the successCB callback with a properties object as a parameter. That object should have a ``value`` property with a String value.
+It returns the formatted number string to the successCB callback with a properties object as a parameter. That object should have a `value` property with a String value.
If there is an error formatting the number, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING\_ERROR.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d9648d01/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/globalization/globalization.stringToNumber.md b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
index db5cf70..b0a2627 100644
--- a/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
+++ b/docs/en/edge/cordova/globalization/globalization.stringToNumber.md
@@ -27,7 +27,7 @@ Parses a number formatted as a string according to the client's user preferences
Description
-----------
-It returns the number to the successCB callback with a properties object as a parameter. That object should have a ``value`` property with a Number value.
+It returns the number to the successCB callback with a properties object as a parameter. That object should have a `value` property with a Number value.
If there is an error parsing the number string, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PARSING\_ERROR.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d9648d01/docs/en/edge/cordova/media/capture/capture.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/capture.md b/docs/en/edge/cordova/media/capture/capture.md
index 7f669df..ffa8553 100644
--- a/docs/en/edge/cordova/media/capture/capture.md
+++ b/docs/en/edge/cordova/media/capture/capture.md
@@ -29,7 +29,7 @@ Objects
- CaptureAudioOptions
- CaptureImageOptions
- CaptureVideoOptions
-- CaptureCB
+- CaptureCallback
- CaptureErrorCB
- ConfigurationData
- MediaFile
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/d9648d01/docs/en/edge/cordova/media/capture/captureAudio.md
----------------------------------------------------------------------
diff --git a/docs/en/edge/cordova/media/capture/captureAudio.md b/docs/en/edge/cordova/media/capture/captureAudio.md
index aceab94..e32d96c 100644
--- a/docs/en/edge/cordova/media/capture/captureAudio.md
+++ b/docs/en/edge/cordova/media/capture/captureAudio.md
@@ -33,7 +33,7 @@ This method starts an asynchronous operation to capture audio recordings using t
The capture operation ends when either the user exits the audio recording application, or the maximum number of recordings, specified by the __limit__ parameter in CaptureAudioOptions, has been reached. If no value is provided for the __limit__ parameter, a default value of one (1) is used, and the capture operation will terminate after the user records a single audio clip.
-When the capture operation is finished, it will invoke the CaptureCB callback with an array of MediaFile objects describing each captured audio clip file. If the operation is terminated by the user before an audio clip is captured, the CaptureErrorCB callback will be invoked with a CaptureError object with the CaptureError.`CAPTURE_NO_MEDIA_FILES` error code.
+When the capture operation is finished, it will invoke the CaptureCallback callback with an array of MediaFile objects describing each captured audio clip file. If the operation is terminated by the user before an audio clip is captured, the CaptureErrorCallback callback will be invoked with a CaptureError object with the CaptureError.`CAPTURE_NO_MEDIA_FILES` error code.
Supported Platforms
-------------------