Adding docs to Element.

sdk/lib/html/dart2js/html_dart2js.dart

 library html;
 
 import 'dart:collection';
 import 'dart:html_common';
 import 'dart:indexed_db';
 import 'dart:isolate';
 import 'dart:json';
 import 'dart:svg' as svg;
 import 'dart:web_audio' as web_audio;
 // Copyright (c) 2012, the Dart project authors.  Please see the AUTHORS file
@@ skipping 7333 matching lines @@
     }
     return s;
   }
 
   void writeClasses(Set<String> s) {
     List list = new List.from(s);
     _element.$dom_className = Strings.join(list, ' ');
   }
 }
 
-/// @domName Element
+/**
+ * An abstract class which all HTML elements extend.
+ */
 abstract class Element extends Node implements ElementTraversal native "*Element" {
 
+  /**
+   * Creates an HTML element from a valid fragment of HTML.
+   *
+   * The [html] fragment must represent valid HTML with a single element root,
+   * which will be parsed and returned.
+   *
+   * Important: the contents of [html] should not contain any user-supplied
+   * data. Without strict data validation it is impossible to prevent script
+   * injection exploits.
+   *
+   * It is instead recommended that elements be constructed via [Element.tag]
+   * and text be added via [text].
+   *
+   *    var element = new Element.html('<div class="foo">content</div>');
+   */
   factory Element.html(String html) =>
       _ElementFactoryProvider.createElement_html(html);
+
+  /**
+   * Creates the HTML element specified by the tag name.
+   *
+   * This is similar to [Document.createElement].
+   * [tag] should be a valid HTML tag name. If [tag] is an unknown tag then
+   * this will create an [UnknownElement].
+   *     var divElement = new Element.tag('div');
+   *     print(divElement is DivElement); // 'true'
+   *     var myElement = new Element.tag('unknownTag');
+   *     print(myElement is UnknownElement); // 'true'
+   * For standard elements it is more preferable to use the type constructors:
+   *     var element = new DivElement();
+   */
   factory Element.tag(String tag) =>
       _ElementFactoryProvider.createElement_tag(tag);
 
   /**
-   * @domName Element.hasAttribute, Element.getAttribute, Element.setAttribute,
-   *   Element.removeAttribute
+   * All attributes on this element.
+   *
+   * Any modifications to the attribute map will automatically be applied to
+   * this element.
+   *
+   * This only includes attributes which are not in a namespace
+   * (such as xlink:href), additional attributes can be accessed via
+   * [getNamespacedAttributes].
    */
   Map<String, String> get attributes => new _ElementAttributeMap(this);
 
   void set attributes(Map<String, String> value) {
     Map<String, String> attributes = this.attributes;
     attributes.clear();
     for (String key in value.keys) {
       attributes[key] = value[key];
     }
   }
@@ skipping 13 matching lines @@
     this.children = value;
   }
 
   /**
    * Deprecated, use [children] instead.
    */
   @deprecated
   List<Element> get elements => this.children;
 
   /**
-   * @domName childElementCount, firstElementChild, lastElementChild,
-   *   children, Node.nodes.add
+   * List of the direct children of this element.
+   *
+   * This collection can be used to add and remove elements from the document.
+   *     var item = new DivElement();
+   *     item.text = 'Something';
+   *     document.body.children.add(item) // Item is now displayed on the page.
+   *     for (var element in document.body.children) {
+   *       element.style.background = 'red'; // Turns every child of body red.
+   *     }
    */
   List<Element> get children => new _ChildrenElementList._wrap(this);
 
   void set children(List<Element> value) {
     // Copy list first since we don't want liveness during iteration.
     List copy = new List.from(value);
     var children = this.children;
     children.clear();
     children.addAll(copy);
   }
 
+  /**
+   * Finds the first descendant element of this element that matches the
+   * specified group of selectors.
+   *
+   * [selectors] should be a string using CSS selector syntax.
+   * Get the first descendant with the class 'classname':
+   *     var element = element.query('.className');
+   * Get the element with id 'id':
+   *     var element = element.query('#id');
+   * Get the first descendant [ImageElement]:
+   *     var img = element.query('img');
+   *
+   * See also:
+   *
+   * * [CSS Selectors](http://docs.webplatform.org/wiki/css/selectors)
+   */
   Element query(String selectors) => $dom_querySelector(selectors);
 
+  /**
+   * Finds all descendent elements of this element that match the specified
+   * group of selectors.
+   *
+   * [selectors] should be a string using CSS selector syntax.
+   *     var items = element.query('.itemClassName');
+   */
   List<Element> queryAll(String selectors) =>
     new _FrozenElementList._wrap($dom_querySelectorAll(selectors));
 
-  /** @domName className, classList */
+  /**
+   * The set of CSS classes applied to this element.
+   *
+   * This set makes it easy to add, remove or toggle the classes applied to
+   * this element.
+   *     element.classes.add('selected');
+   *     element.classes.toggle('isOnline');
+   *     element.classes.remove('selected');
+   */
   CssClassSet get classes => new _ElementCssClassSet(this);
 
   void set classes(Collection<String> value) {
     CssClassSet classSet = classes;
     classSet.clear();
     classSet.addAll(value);
   }
 
+  /**
+   * Allows access to all custom data attributes (data-*) set on this element.
+   *
+   * The keys for the map must follow these rules:
+   *
+   * * The name must not begin with `xml`.
+   * * The name cannot contain a semi-colon (`;`).
+   * * The name cannot contain any capital letters.
+   *
+   * Any keys from markup will be converted to camel-cased keys in the map.
+   * For example, HTML specified as:
+   *     <div data-my-random-value='value'></div>div

[Kathy Walrath, 2012/12/12 19:16:06]

</div>div -> </div>

?

[blois, 2012/12/12 19:46:29]

Done.

+   * Would be accessed in Dart as:
+   *     var value = element.dataAttributes['myRandomValue'];
+   *
+   * See also:
+   *
+   * * [Custom data attributes](http://www.w3.org/TR/html5/global-attributes.html#custom-data-attribute)
+   */
   Map<String, String> get dataAttributes =>
     new _DataAttributeMap(attributes);
 
   void set dataAttributes(Map<String, String> value) {
     final dataAttributes = this.dataAttributes;
     dataAttributes.clear();
     for (String key in value.keys) {
       dataAttributes[key] = value[key];
     }
   }
 
   /**
    * Gets a map for manipulating the attributes of a particular namespace.
+   *
    * This is primarily useful for SVG attributes such as xref:link.
    */
   Map<String, String> getNamespacedAttributes(String namespace) {
     return new _NamespacedAttributeMap(this, namespace);
   }
 
-  /** @domName Window.getComputedStyle */
+  /**
+   * The set of all CSS values applied to this element, including inherited
+   * and default values.
+   *
+   * The computedStyle contains the values which are inherited from other

[Kathy Walrath, 2012/12/12 19:16:06]

which -> that

the values -> values?

[blois, 2012/12/12 19:46:29]

Done.

+   * sources, such as parent elements or stylesheets. This differs from the
+   * [style] property which contains the values specified directly on this

[Kathy Walrath, 2012/12/12 19:16:06]

which -> , which

(in general, you should either have a comma before "which" -- if removing that
phrase wouldn't change the meaning of the word/phrase before -- or change
"which" to "that", for clarity)

the values -> only the values

[blois, 2012/12/12 19:46:29]

Done.

+   * element,

[Kathy Walrath, 2012/12/12 19:16:06]

element, -> element.

(period)

[blois, 2012/12/12 19:46:29]

Done.

[blois, 2012/12/12 19:46:29]

Done.

+   *
+   * See also:
+   *
+   * * [CSS Inheritance and Cascade](http://docs.webplatform.org/wiki/tutorials/inheritance_and_cascade)
+   */
   Future<CssStyleDeclaration> get computedStyle {
      // TODO(jacobr): last param should be null, see b/5045788
      return getComputedStyle('');
   }
 
-  /** @domName Window.getComputedStyle */
+  /**
+   * This returns the computed styles for pseudo-elements such as

[Kathy Walrath, 2012/12/12 19:16:06]

This returns -> Returns

[blois, 2012/12/12 19:46:29]

Done.

+   * `::after, ::before, ::marker, ::line-marker`.
+   *
+   * See also:
+   *
+   * * [Pseudo-elements](http://docs.webplatform.org/wiki/css/selectors/pseudo-elements)
+   */
   Future<CssStyleDeclaration> getComputedStyle(String pseudoElement) {
     return _createMeasurementFuture(
         () => window.$dom_getComputedStyle(this, pseudoElement),
         new Completer<CssStyleDeclaration>());
   }
 
   /**
    * Adds the specified element to after the last child of this.

[Kathy Walrath, 2012/12/12 19:16:06]

this -> this element

(seems more natural)

[blois, 2012/12/12 19:46:29]

Done.

    */
   void append(Element e) {
     this.children.add(e);
   }
 
   /**
    * Adds the specified text as a text node after the last child of this.

[Kathy Walrath, 2012/12/12 19:16:06]

this -> this element

[blois, 2012/12/12 19:46:29]

Done.

    */
   void appendText(String text) {
     this.insertAdjacentText('beforeend', text);
   }
 
   /**
    * Parses the specified text as HTML and adds the resulting node after the
    * last child of this.

[Kathy Walrath, 2012/12/12 19:16:06]

this -> this element

[blois, 2012/12/12 19:46:29]

Done.

    */
   void appendHtml(String text) {
     this.insertAdjacentHtml('beforeend', text);
   }
 
   // Hooks to support custom WebComponents.
   /**
    * Experimental support for [web components][wc]. This field stores a
    * reference to the component implementation. It was inspired by Mozilla's
    * [x-tags][] project. Please note: in the future it may be possible to
    * `extend Element` from your class, in which case this field will be
    * deprecated and will simply return this [Element] object.
    *
    * [wc]: http://dvcs.w3.org/hg/webcomponents/raw-file/tip/explainer/index.html
    * [x-tags]: http://x-tags.org/
    */
   @Creates('Null')  // Set from Dart code; does not instantiate a native type.
   var xtag;
 
   // TODO(vsm): Implement noSuchMethod or similar for dart2js.
 
-  /** @domName Element.insertAdjacentText */
+  /**
+   * Creates a text node and inserts it into the DOM at the specified location.
+   *
+   * The [where] parameter indicates where to insert [text]:
+   *
+   * * `beforeBegin` Immediately before this element.

[Kathy Walrath, 2012/12/12 19:16:06]

These bullets seem like they wouldn't look right in the doc (a colon might help
here). Also, because these are string values, you should use '. So maybe:

 * * 'beforeBegin': Immediately...

Do the same fix wherever this string is in the doc. Or better yet, document it
in just one place and then refer people to that method for the discussion. E.g.:

 * To see the possible values for [where], read the doc for
[insertAdjacentHtml].

[blois, 2012/12/12 19:46:29]

Done.

+   * * `afterBegin` As the first child of this element.
+   * * `beforeEnd` As the last child of this element.
+   * * `afterEnd` Immediately after this element.
+   *
+   * See also:
+   *
+   * * [insertAdjacentHtml]
+   */
   void insertAdjacentText(String where, String text) {
     if (JS('bool', '!!#.insertAdjacentText', this)) {
       _insertAdjacentText(where, text);
     } else {
       _insertAdjacentNode(where, new Text(text));
     }
   }
 
   @JSName('insertAdjacentText')
   void _insertAdjacentText(String where, String text) native;
 
-  /** @domName Element.insertAdjacentHTML */
+  /**
+   * Parses text as an HTML fragment and inserts it into the DOM at the
+   * specified location.
+   *
+   * The [where] parameter indicates where to insert the HTML fragment:
+   *
+   * * `beforeBegin` Immediately before this element.
+   * * `afterBegin` As the first child of this element.
+   * * `beforeEnd` As the last child of this element.
+   * * `afterEnd` Immediately after this element.
+   *
+   *     var html = '<div class="something">content</div>';
+   *     // Inserts as the first child
+   *     document.body.insertAdjacentHtml('afterBegin', html);
+   *     var createdElement = document.body.children[0];
+   *     print(createdElement.classes[0]); // Prints 'something'

[Kathy Walrath, 2012/12/12 19:16:06]

Perhaps this method should be the one that the main doc AND links to related
methods (insertAdjacentText, insertAdjacentElement).

[blois, 2012/12/12 19:46:29]

Done.

+   */
   void insertAdjacentHtml(String where, String text) {
     if (JS('bool', '!!#.insertAdjacentHtml', this)) {
       _insertAdjacentHtml(where, text);
     } else {
       _insertAdjacentNode(where, new DocumentFragment.html(text));
     }
   }
 
   @JSName('insertAdjacentHTML')
   void _insertAdjacentHTML(String where, String text) native;
 
-  /** @domName Element.insertAdjacentHTML */
+  /**
+   * Inserts [element] into the DOM at the specified location.
+   *
+   * The [where] parameter indicates where to insert [element]:
+   *
+   * * `beforeBegin` Immediately before this element.
+   * * `afterBegin` As the first child of this element.
+   * * `beforeEnd` As the last child of this element.
+   * * `afterEnd` Immediately after this element.
+   *
+   * See also:
+   *
+   * * [insertAdjacentHtml]
+   */
   Element insertAdjacentElement(String where, Element element) {
     if (JS('bool', '!!#.insertAdjacentElement', this)) {
       _insertAdjacentElement(where, element);
     } else {
       _insertAdjacentNode(where, element);
     }
     return element;
   }
 
   @JSName('insertAdjacentElement')
@@ skipping 18173 matching lines @@
   T next() {
     if (!hasNext) {
       throw new StateError("No more elements");
     }
     return _array[_pos++];
   }
 
   final List<T> _array;
   int _pos;
 }