Document dart:html Storage interface to demonstrate usage

[sethladd]

http://api.dartlang.org/html/Storage.html

The Storage interface should have non-$dom methods for

interface Storage {
  readonly attribute unsigned long length;
  [IndexGetter] DOMString key(in unsigned long index);
  [NameGetter] DOMString getItem(in DOMString key);
  [NameSetter] void setItem(in DOMString key, in DOMString data);
  [NameDeleter] void removeItem(in DOMString key);
  void clear();
};

[vsmenon]

If you look at the fine print, you'll see that it extends the Dart Map type instead. See sample usage here:

http://code.google.com/p/dart/source/browse/branches/bleeding_edge/dart/tests/html/localstorage_test.dart

[sethladd]

Touche' ! :)

OK, how about putting a class level doc at the top of the method? This class level doc would show an example of usage, or at a minimal say "This interface extends Map, thus you can access local storage and session storage keys and values just like a Map."

Is this interface auto-generated? Or is it something I can submit a patch for?

[vsmenon]

It is auto-generated ... but it'd be great to support a workflow that let you edit class and method level docs without having to muck with scripts and templates.

We do some post-processing in apidoc to link to MDN. Should we do something similar to inline docs?

[sethladd]

I am very happy to write the doc copy if there's a way to jam it in. If you think apidoc is the right way to do that, I can poke around if I have time soon.

In this case, there's another issue with Storage and MDN docs: issue #3090 (wrong MDN docs)

[vsmenon]

I'm repurposing this to add documentation for this class once we fix 3103 (on blocking list).

---

Set owner to @sethladd.
Marked this as being blocked by #3103.
Changed the title to: "Document dart:html Storage interface to demonstrate usage".

[sethladd]

Hi Alex, please add some very basic docs, and remove the MDN boilerplate, from this interface, before IO. Thanks!

---

Set owner to [email protected].
Added this to the IO2012 milestone.

[kwalrath]

CL:
https://chromiumcodereview.appspot.com/10684008/

Docs staged at:
http://kathy-02.dartlang-api.appspot.com/html/Storage.html

---

Set owner to @kwalrath.
Added Started label.
Marked this as being blocked by #3103.
Unmarked this as being blocked by #3103.

[kwalrath]

http://api.dartlang.org/html/Storage.html now has a summary and links to more info.

---

Added Fixed label.