pkg/docgen: fixed type references within typedef doc comments

pkg/docgen: fixed type references within typedef doc comments

R=efortuna@google.com

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

[kevmoo, 2014-04-20 21:34:54]

https://codereview.chromium.org/243483005/diff/1/pkg/docgen/lib/src/models/an...
File pkg/docgen/lib/src/models/annotation.dart (right):

https://codereview.chromium.org/243483005/diff/1/pkg/docgen/lib/src/models/an...
pkg/docgen/lib/src/models/annotation.dart:16: class Annotation extends
MirrorBased<ClassMirror> {
Added a generic param to MirrorBased to improve type checks in subclasses.

Actually using in now

https://codereview.chromium.org/243483005/diff/1/pkg/docgen/lib/src/models/an...
pkg/docgen/lib/src/models/annotation.dart:24: parameters =
_createParamaters(originalMirror);
popped this mountain of code into a helper

https://codereview.chromium.org/243483005/diff/1/pkg/docgen/lib/src/models/in...
File pkg/docgen/lib/src/models/indexable.dart (right):

https://codereview.chromium.org/243483005/diff/1/pkg/docgen/lib/src/models/in...
pkg/docgen/lib/src/models/indexable.dart:126: String get typeName;
Every type implements this, so making it abstract.

https://codereview.chromium.org/243483005/diff/1/pkg/docgen/lib/src/models/me...
File pkg/docgen/lib/src/models/method.dart (right):

https://codereview.chromium.org/243483005/diff/1/pkg/docgen/lib/src/models/me...
pkg/docgen/lib/src/models/method.dart:86: if (mirror.isConstructor) {
Benefit of defining the generic type of 'mirror'

https://codereview.chromium.org/243483005/diff/1/pkg/docgen/lib/src/models/me...
pkg/docgen/lib/src/models/method.dart:127: if (mirror.isConstructor) return
'constructor';
Benefit of defining the generic type of 'mirror'

https://codereview.chromium.org/243483005/diff/1/pkg/docgen/lib/src/models/ty...
File pkg/docgen/lib/src/models/typedef.dart (right):

https://codereview.chromium.org/243483005/diff/1/pkg/docgen/lib/src/models/ty...
pkg/docgen/lib/src/models/typedef.dart:64: /// Look for the specified name
starting with the current member, and
Copied from Method. Works perfectly.

https://codereview.chromium.org/243483005/diff/1/pkg/docgen/lib/src/models/va...
File pkg/docgen/lib/src/models/variable.dart (left):

https://codereview.chromium.org/243483005/diff/1/pkg/docgen/lib/src/models/va...
pkg/docgen/lib/src/models/variable.dart:44: String get name => _variableName;
Replaced private field + getter into public field 'name'

https://codereview.chromium.org/243483005/diff/1/pkg/docgen/test/multi_librar...
File pkg/docgen/test/multi_library_code/lib/root_lib.dart (right):

https://codereview.chromium.org/243483005/diff/1/pkg/docgen/test/multi_librar...
pkg/docgen/test/multi_library_code/lib/root_lib.dart:5: library root_lib;
Test library with just exports. typedef was failing in this case

https://codereview.chromium.org/243483005/diff/1/pkg/docgen/test/multi_librar...
File pkg/docgen/test/multi_library_code/lib/test_lib_bar.dart (right):

https://codereview.chromium.org/243483005/diff/1/pkg/docgen/test/multi_librar...
pkg/docgen/test/multi_library_code/lib/test_lib_bar.dart:16: /// Processes an
[input] of type [C] instance for testing.
The method and the typedef have the same signature. This makes it easy to see
where typedef is broken

[Emily Fortuna, 2014-04-21 16:34:23]

https://codereview.chromium.org/243483005/diff/20001/pkg/docgen/lib/src/model...
File pkg/docgen/lib/src/models/indexable.dart (left):

https://codereview.chromium.org/243483005/diff/20001/pkg/docgen/lib/src/model...
pkg/docgen/lib/src/models/indexable.dart:126: /// The type of this member to be
used in index.txt.
why delete a comment?

https://codereview.chromium.org/243483005/diff/20001/pkg/docgen/lib/src/model...
File pkg/docgen/lib/src/models/typedef.dart (right):

https://codereview.chromium.org/243483005/diff/20001/pkg/docgen/lib/src/model...
pkg/docgen/lib/src/models/typedef.dart:69: // do we check for a dummy mirror
returned here and look up with an owner
comments start with a capital letter, and end with a period....
also can you more clearly explain your logic here?

[kevmoo, 2014-04-21 17:52:14]

PTAL

https://codereview.chromium.org/243483005/diff/20001/pkg/docgen/lib/src/model...
File pkg/docgen/lib/src/models/indexable.dart (left):

https://codereview.chromium.org/243483005/diff/20001/pkg/docgen/lib/src/model...
pkg/docgen/lib/src/models/indexable.dart:126: /// The type of this member to be
used in index.txt.
On 2014/04/21 16:34:23, Emily Fortuna wrote:
> why delete a comment?

Good point. Fixed.

https://codereview.chromium.org/243483005/diff/20001/pkg/docgen/lib/src/model...
File pkg/docgen/lib/src/models/typedef.dart (right):

https://codereview.chromium.org/243483005/diff/20001/pkg/docgen/lib/src/model...
pkg/docgen/lib/src/models/typedef.dart:69: // do we check for a dummy mirror
returned here and look up with an owner
On 2014/04/21 16:34:23, Emily Fortuna wrote:
> comments start with a capital letter, and end with a period....
> also can you more clearly explain your logic here?

This was a copy-paste from Method.dart

I've discovered that the impl in Variable is better, actually. I've updated the
CL

https://codereview.chromium.org/243483005/diff/40001/pkg/docgen/lib/src/model...
File pkg/docgen/lib/src/models/owned_indexable.dart (right):

https://codereview.chromium.org/243483005/diff/40001/pkg/docgen/lib/src/model...
pkg/docgen/lib/src/models/owned_indexable.dart:53: String
findElementInScope(String name) {
This is blindly moved from Variable. It is now shared by Variable and Typedef

https://codereview.chromium.org/243483005/diff/40001/pkg/docgen/lib/src/model...
File pkg/docgen/lib/src/models/variable.dart (left):

https://codereview.chromium.org/243483005/diff/40001/pkg/docgen/lib/src/model...
pkg/docgen/lib/src/models/variable.dart:68: String findElementInScope(String
name) {
Moved up to OwnedIndexable

[Emily Fortuna, 2014-04-21 18:31:04]

lgtm

https://codereview.chromium.org/243483005/diff/40001/utils/apidoc/docgen.gyp
File utils/apidoc/docgen.gyp (right):

https://codereview.chromium.org/243483005/diff/40001/utils/apidoc/docgen.gyp#...
utils/apidoc/docgen.gyp:83: '--indent-json',
:-)

[kevmoo, 2014-04-21 18:36:07]

https://codereview.chromium.org/243483005/diff/40001/utils/apidoc/docgen.gyp
File utils/apidoc/docgen.gyp (right):

https://codereview.chromium.org/243483005/diff/40001/utils/apidoc/docgen.gyp#...
utils/apidoc/docgen.gyp:83: '--indent-json',
On 2014/04/21 18:31:04, Emily Fortuna wrote:
> :-)

I just removed this. Don't think it's a good idea...

[kevmoo, 2014-04-21 18:37:34]

Committed patchset #4 manually as r35216 (presubmit successful).