W3C home > Mailing lists > Public > public-script-coord@w3.org > October to December 2012

Re: [WebIDL] Would it make sense to add annotations for "creates a new object each time" and "always returns the same object"?

From: Glenn Adams <glenn@skynav.com>
Date: Fri, 19 Oct 2012 07:55:47 +0700
Message-ID: <CACQ=j+cY8hw5hVS+cuq6KGG3J3zHWunmPwan9zFmB-ZyrvN2AA@mail.gmail.com>
To: Boris Zbarsky <bzbarsky@mit.edu>
Cc: "public-script-coord@w3.org" <public-script-coord@w3.org>
On Thu, Oct 18, 2012 at 9:11 PM, Boris Zbarsky <bzbarsky@mit.edu> wrote:

> Consider a method declaration like so:
>
>   MyInterface getFoo();
>
> It's impossible to tell from that IDL whether you get back the same object
> every time or whether the same object is returned each time, or whether
> it's sometimes the same and sometimes a new one.  Generally you have to
> rely on the prose to indicate that, and often the writers of the prose
> forget to do so.
>
> In Gecko, we have found it useful to annotate methods and attributes with
> this sort of information (we use [Creator] for methods that always return a
> new object and we're about to add an annotation for attributes that always
> return the same object, but we haven't decided on a name for it yet).
>
> Would it make sense to add such annotations to WebIDL so that this sort of
> thing doesn't have to be described in prose?


+1
Received on Friday, 19 October 2012 00:56:35 UTC

This archive was generated by hypermail 2.3.1 : Wednesday, 8 May 2013 19:30:07 UTC