552092 - Expose a length property on mozIStorageBindingParamsArray

Status: RESOLVED FIXED

(Toolkit :: Storage, defect)

Description

[Shawn Wilsher :sdwilsh]

Attachment: v1.0

since it's a misuse of the API to bind one of these that is empty to mozIStorageStatement, we should expose the length.

Comment 1

[Robert Strong (they/them - no direct email)]

Comment on attachment 432241 [details] [diff] [review]
v1.0

>diff --git a/storage/public/mozIStorageBindingParamsArray.idl b/storage/public/mozIStorageBindingParamsArray.idl
>--- a/storage/public/mozIStorageBindingParamsArray.idl
>+++ b/storage/public/mozIStorageBindingParamsArray.idl
>@@ -32,31 +32,36 @@
>  * use your version of this file under the terms of the MPL, indicate your
>  * decision by deleting the provisions above and replace them with the notice
>  * and other provisions required by the GPL or the LGPL. If you do not delete
>  * the provisions above, a recipient may use your version of this file under
>  * the terms of any one of the MPL, the GPL or the LGPL.
>  *
>  * ***** END LICENSE BLOCK ***** */
> 
> #include "nsISupports.idl"
> 
> interface mozIStorageBindingParams;
> 
>-[scriptable, uuid(e676e1a3-1dc6-4802-ac03-291fa9de7f93)]
>+[scriptable, uuid(67eea5c3-4881-41ff-b0fe-09f2356aeadb)]
> interface mozIStorageBindingParamsArray : nsISupports {
>   /**
>    * Creates a new mozIStorageBindingParams object that can be added to this
>    * array.
>    *
>-   * @returns a mozIStorageBindingParams object that can be used to specify
>-   *          parameters that need to be bound.
>+   * @return a mozIStorageBindingParams object that can be used to specify
>+   *         parameters that need to be bound.
@return has 570 matching lines in 200 idl files
@returns has 177 matching lines in 56 idl files
sold

>    */
>   mozIStorageBindingParams newBindingParams();
> 
>   /**
>    * Adds the parameters to the end of this array.
>    *
>    * @param aParameters
>    *        The parameters to add to this array.
>    */
>   void addParams(in mozIStorageBindingParams aParameters);
>+
>+  /**
>+   * @return the amount of mozIStorageBindingParams this object contains.
>+   */
>+  readonly attribute unsigned long length;
Attributes in idl files don't use @return for their description from my experience.
length attributes usually use the term number and not amount. Perhaps
The number of parameters in the mozIStorageBindingParams array

sr=me with that or an explanation as to why these idl comments should be different, etc.

Comment 2

[Shawn Wilsher :sdwilsh]

(In reply to comment #1)
> @return has 570 matching lines in 200 idl files
> @returns has 177 matching lines in 56 idl files
> sold
Yeah, @returns is also wrong according to java-doc specs :)

> Attributes in idl files don't use @return for their description from my
> experience.
I think I just got carried away there...

> length attributes usually use the term number and not amount. Perhaps
> The number of parameters in the mozIStorageBindingParams array
Done.

Comment 3

[Shawn Wilsher :sdwilsh]

I'll update the target milestone later today when it gets added to the list...

http://hg.mozilla.org/mozilla-central/rev/cbf4b59a607d

Comment 4

[Eric Shepherd [:sheppy]]

Documented:

https://developer.mozilla.org/en/mozIStorageBindingParamsArray#Attributes