Cleanup mdn scripts

Cleanup mdn scripts


BUG=
TEST=

Committed: https://code.google.com/p/dart/source/detail?r=3920

[Jacob, 2012-02-01 08:00:38]

Responses to nweiz code review comments.
Fix apidoc script so that the mdn comments for properties show up.  I made the
arbitrary choice to display them for the getters.  Clearly things will be better
once Bob tweaks to output to display a unified comment for the getter and setter
but for now this is a huge improvement as now all properties have comments.

For example:
http://www.corp.google.com/~jacobr/apidoc/docs/dom/Element.html

[Bob Nystrom, 2012-02-01 18:41:12]

Couple of nits but LGTM. Thanks for doing this!

http://chromiumcodereview.appspot.com/9315026/diff/1/client/html/release/html...
File client/html/release/htmlimpl.dart (right):

http://chromiumcodereview.appspot.com/9315026/diff/1/client/html/release/html...
client/html/release/htmlimpl.dart:22176: +  	assert(isEmpty);
Is this a workaround for that bug last night? If so, leave a comment explaining
that so that someone doesn't refactor this to the obvious single line and
accidentally break it again.

http://chromiumcodereview.appspot.com/9315026/diff/1/client/html/release/html...
client/html/release/htmlimpl.dart:23141: +// Copyright (c) 2011, the Dart
project authors.  Please see the AUTHORS file
Should be 2012.

http://chromiumcodereview.appspot.com/9315026/diff/1/client/html/src/DOMWrapp...
File client/html/src/DOMWrapperBase.dart (right):

http://chromiumcodereview.appspot.com/9315026/diff/1/client/html/src/DOMWrapp...
client/html/src/DOMWrapperBase.dart:12: // chrome.
Good comment!

http://chromiumcodereview.appspot.com/9315026/diff/1/utils/apidoc/apidoc.dart
File utils/apidoc/apidoc.dart (right):

http://chromiumcodereview.appspot.com/9315026/diff/1/utils/apidoc/apidoc.dart...
utils/apidoc/apidoc.dart:166: if (0 == 1 && isNonEmpty(dartComment)) {
Debug code? Remove?

http://chromiumcodereview.appspot.com/9315026/diff/1/utils/apidoc/apidoc.dart...
utils/apidoc/apidoc.dart:283: String nameToFind = member.name;
I think we're moving away from type annotating local variables. It's up to your
preference, but I would encourage you to be consistent with surrounding code
which here isn't annotating them.

http://chromiumcodereview.appspot.com/9315026/diff/1/utils/apidoc/apidoc.dart...
utils/apidoc/apidoc.dart:288: for (Map candidateMember in mdnType['members']) {
Ditto.

http://chromiumcodereview.appspot.com/9315026/diff/1/utils/apidoc/mdn/extract...
File utils/apidoc/mdn/extract.dart (right):

http://chromiumcodereview.appspot.com/9315026/diff/1/utils/apidoc/mdn/extract...
utils/apidoc/mdn/extract.dart:304: final nodes = <Text>[];
:D

http://chromiumcodereview.appspot.com/9315026/diff/1/utils/apidoc/mdn/extract...
utils/apidoc/mdn/extract.dart:412: // useful text description so suppress it.
Comments like this are very helpful.

http://chromiumcodereview.appspot.com/9315026/diff/1/utils/apidoc/mdn/extract...
utils/apidoc/mdn/extract.dart:615: && txt.contains(")")) {
This will probably fit on one line now.

http://chromiumcodereview.appspot.com/9315026/diff/1/utils/apidoc/mdn/extract...
utils/apidoc/mdn/extract.dart:881: bool maybeName(String name) {
Doesn't seem to be used?

http://chromiumcodereview.appspot.com/9315026/diff/1/utils/apidoc/mdn/extract...
utils/apidoc/mdn/extract.dart:1115: if (!foundMatch ){
Remove space before ")".

[Jacob, 2012-02-01 21:12:02]

http://chromiumcodereview.appspot.com/9315026/diff/1/client/html/release/html...
File client/html/release/htmlimpl.dart (right):

http://chromiumcodereview.appspot.com/9315026/diff/1/client/html/release/html...
client/html/release/htmlimpl.dart:22176: +  	assert(isEmpty);
On 2012/02/01 18:41:13, Bob Nystrom wrote:
> Is this a workaround for that bug last night? If so, leave a comment
explaining
> that so that someone doesn't refactor this to the obvious single line and
> accidentally break it again.
There is a comment. I just didn't run the release script after adding it.

http://chromiumcodereview.appspot.com/9315026/diff/1/utils/apidoc/apidoc.dart
File utils/apidoc/apidoc.dart (right):

http://chromiumcodereview.appspot.com/9315026/diff/1/utils/apidoc/apidoc.dart...
utils/apidoc/apidoc.dart:166: if (0 == 1 && isNonEmpty(dartComment)) {
On 2012/02/01 18:41:13, Bob Nystrom wrote:
> Debug code? Remove?

Done.

http://chromiumcodereview.appspot.com/9315026/diff/1/utils/apidoc/apidoc.dart...
utils/apidoc/apidoc.dart:283: String nameToFind = member.name;
On 2012/02/01 18:41:13, Bob Nystrom wrote:
> I think we're moving away from type annotating local variables. It's up to
your
> preference, but I would encourage you to be consistent with surrounding code
> which here isn't annotating them.

Done.

http://chromiumcodereview.appspot.com/9315026/diff/1/utils/apidoc/apidoc.dart...
utils/apidoc/apidoc.dart:288: for (Map candidateMember in mdnType['members']) {
On 2012/02/01 18:41:13, Bob Nystrom wrote:
> Ditto.
This type cannot possible be inferred and the word Map has the same number of
chars as the word var so I see little advantage in using var instead of Map. 
However switched back to final.

http://chromiumcodereview.appspot.com/9315026/diff/1/utils/apidoc/mdn/extract...
File utils/apidoc/mdn/extract.dart (right):

http://chromiumcodereview.appspot.com/9315026/diff/1/utils/apidoc/mdn/extract...
utils/apidoc/mdn/extract.dart:304: final nodes = <Text>[];
On 2012/02/01 18:41:13, Bob Nystrom wrote:
> :D

Done.

http://chromiumcodereview.appspot.com/9315026/diff/1/utils/apidoc/mdn/extract...
utils/apidoc/mdn/extract.dart:412: // useful text description so suppress it.
On 2012/02/01 18:41:13, Bob Nystrom wrote:
> Comments like this are very helpful.

Done.

http://chromiumcodereview.appspot.com/9315026/diff/1/utils/apidoc/mdn/extract...
utils/apidoc/mdn/extract.dart:615: && txt.contains(")")) {
On 2012/02/01 18:41:13, Bob Nystrom wrote:
> This will probably fit on one line now.

Done.

http://chromiumcodereview.appspot.com/9315026/diff/1/utils/apidoc/mdn/extract...
utils/apidoc/mdn/extract.dart:881: bool maybeName(String name) {
On 2012/02/01 18:41:13, Bob Nystrom wrote:
> Doesn't seem to be used?
It is used.  You must be just searching this diff instead of the entire file.

http://chromiumcodereview.appspot.com/9315026/diff/1/utils/apidoc/mdn/extract...
utils/apidoc/mdn/extract.dart:1115: if (!foundMatch ){
On 2012/02/01 18:41:13, Bob Nystrom wrote:
> Remove space before ")".

rem   oved        space    )

[nweiz, 2012-02-02 00:16:19]

lgtm

http://chromiumcodereview.appspot.com/9315026/diff/3007/utils/apidoc/mdn/extr...
File utils/apidoc/mdn/extract.dart (right):

http://chromiumcodereview.appspot.com/9315026/diff/3007/utils/apidoc/mdn/extr...
utils/apidoc/mdn/extract.dart:377: Element returnValue;
Maybe "parametersHeader" and "returnHeader"? Current naming implies these will
have the parameters/return value inside them.

http://chromiumcodereview.appspot.com/9315026/diff/3007/utils/apidoc/mdn/extr...
utils/apidoc/mdn/extract.dart:391: numEmptyParameters++;
"numEmptyParameters = parameterDescriptions.filter((d) => d.text.trim().length
== 0).length" seems clearer and more concise.

http://chromiumcodereview.appspot.com/9315026/diff/3007/utils/apidoc/mdn/extr...
File utils/apidoc/mdn/extractRunner.js (right):

http://chromiumcodereview.appspot.com/9315026/diff/3007/utils/apidoc/mdn/extr...
utils/apidoc/mdn/extractRunner.js:53: var matchIndex =
inputFile.toLowerCase().indexOf("<!doctype");
I think you could still make this 'inputFile.toLowerCase().indexOf("<!doctype",
1);' and get rid of the substr above.