Skip to content

Commit 260c5ce

Browse files
committed
Merge pull request #1083 from keertip/analyze
fix analyzer warnings
2 parents aa50c40 + bd1e6d9 commit 260c5ce

File tree

5 files changed

+56
-57
lines changed

5 files changed

+56
-57
lines changed

lib/dartdoc.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export 'src/package_meta.dart';
3838

3939
const String name = 'dartdoc';
4040
// Update when pubspec version changes.
41-
const String version = '0.8.5';
41+
const String version = '0.8.5-dev';
4242

4343
final String defaultOutDir = p.join('doc', 'api');
4444

lib/src/element_type.dart

Lines changed: 49 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,10 @@ class ElementType {
1616

1717
ElementType(this._type, this.element);
1818

19-
String toString() => "$_type";
20-
2119
bool get isDynamic => _type.isDynamic;
2220

23-
bool get isParameterType => (_type is TypeParameterType);
24-
2521
bool get isFunctionType => (_type is FunctionType);
2622

27-
String get name => _type.name;
28-
29-
DartType get _returnTypeCore => (_type as FunctionType).returnType;
30-
3123
bool get isParameterizedType {
3224
if (_type is FunctionType) {
3325
return (_type as FunctionType).boundTypeParameters.isNotEmpty;
@@ -37,17 +29,38 @@ class ElementType {
3729
return false;
3830
}
3931

40-
String get _returnTypeName => _returnTypeCore.name;
32+
bool get isParameterType => (_type is TypeParameterType);
4133

42-
ElementType get _returnType {
43-
var rt = _returnTypeCore;
44-
Library lib = element.package.findLibraryFor(rt.element);
45-
if (lib == null) {
46-
lib = new Library(rt.element.library, element.package);
34+
String get linkedName {
35+
if (_linkedName != null) return _linkedName;
36+
37+
StringBuffer buf = new StringBuffer();
38+
39+
if (isParameterType) {
40+
buf.write(name);
41+
} else {
42+
buf.write(element.linkedName);
4743
}
48-
return new ElementType(rt, new ModelElement.from(rt.element, lib));
44+
45+
// not TypeParameterType or Void or Union type
46+
if (isParameterizedType) {
47+
if (typeArguments.every((t) => t.linkedName == 'dynamic')) {
48+
_linkedName = buf.toString();
49+
return _linkedName;
50+
}
51+
if (typeArguments.isNotEmpty) {
52+
buf.write('<');
53+
buf.writeAll(typeArguments.map((t) => t.linkedName), ', ');
54+
buf.write('>');
55+
}
56+
}
57+
_linkedName = buf.toString();
58+
59+
return _linkedName;
4960
}
5061

62+
String get name => _type.name;
63+
5164
ModelElement get returnElement {
5265
Element e = _returnTypeCore.element;
5366
if (e == null) {
@@ -64,7 +77,7 @@ class ElementType {
6477
if (_type is FunctionType) {
6578
return (_type as FunctionType)
6679
.boundTypeParameters
67-
.map((f) => _getElementTypeFrom(f))
80+
.map((f) => _getElementTypeFrom(f.type))
6881
.toList();
6982
} else {
7083
return (_type as ParameterizedType)
@@ -74,43 +87,18 @@ class ElementType {
7487
}
7588
}
7689

77-
ElementType _getElementTypeFrom(DartType f) {
78-
Library lib;
79-
// can happen if element is dynamic
80-
lib = element.package.findLibraryFor(f.element);
81-
if (lib == null && f.element.library != null) {
82-
lib = new Library(f.element.library, element.package);
90+
ElementType get _returnType {
91+
var rt = _returnTypeCore;
92+
Library lib = element.package.findLibraryFor(rt.element);
93+
if (lib == null) {
94+
lib = new Library(rt.element.library, element.package);
8395
}
84-
return new ElementType(f, new ModelElement.from(f.element, lib));
96+
return new ElementType(rt, new ModelElement.from(rt.element, lib));
8597
}
8698

87-
String get linkedName {
88-
if (_linkedName != null) return _linkedName;
89-
90-
StringBuffer buf = new StringBuffer();
91-
92-
if (isParameterType) {
93-
buf.write(name);
94-
} else {
95-
buf.write(element.linkedName);
96-
}
97-
98-
// not TypeParameterType or Void or Union type
99-
if (isParameterizedType) {
100-
if (typeArguments.every((t) => t.linkedName == 'dynamic')) {
101-
_linkedName = buf.toString();
102-
return _linkedName;
103-
}
104-
if (typeArguments.isNotEmpty) {
105-
buf.write('<');
106-
buf.writeAll(typeArguments.map((t) => t.linkedName), ', ');
107-
buf.write('>');
108-
}
109-
}
110-
_linkedName = buf.toString();
99+
DartType get _returnTypeCore => (_type as FunctionType).returnType;
111100

112-
return _linkedName;
113-
}
101+
String get _returnTypeName => _returnTypeCore.name;
114102

115103
String createLinkedReturnTypeName() {
116104
if (_returnTypeCore.element == null ||
@@ -128,4 +116,16 @@ class ElementType {
128116
return _returnType.linkedName;
129117
}
130118
}
119+
120+
String toString() => "$_type";
121+
122+
ElementType _getElementTypeFrom(DartType f) {
123+
Library lib;
124+
// can happen if element is dynamic
125+
lib = element.package.findLibraryFor(f.element);
126+
if (lib == null && f.element.library != null) {
127+
lib = new Library(f.element.library, element.package);
128+
}
129+
return new ElementType(f, new ModelElement.from(f.element, lib));
130+
}
131131
}

lib/src/model.dart

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -827,7 +827,7 @@ class Field extends ModelElement
827827
@override
828828
String get _computeDocumentationComment {
829829
String docs = getterSetterDocumentationComment;
830-
if (docs.isEmpty) return _field.computeDocumentationComment();
830+
if (docs.isEmpty) return _field.documentationComment;
831831
return docs;
832832
}
833833

@@ -862,12 +862,12 @@ abstract class GetterSetterCombo {
862862
var buffer = new StringBuffer();
863863

864864
if (hasGetter && !_getter.isSynthetic) {
865-
String docs = stripComments(_getter.computeDocumentationComment());
865+
String docs = stripComments(_getter.documentationComment);
866866
if (docs != null) buffer.write(docs);
867867
}
868868

869869
if (hasSetter && !_setter.isSynthetic) {
870-
String docs = stripComments(_setter.computeDocumentationComment());
870+
String docs = stripComments(_setter.documentationComment);
871871
if (docs != null) {
872872
if (buffer.isNotEmpty) buffer.write('\n\n');
873873
buffer.write(docs);
@@ -1963,7 +1963,7 @@ class TopLevelVariable extends ModelElement
19631963
@override
19641964
String get _computeDocumentationComment {
19651965
String docs = getterSetterDocumentationComment;
1966-
if (docs.isEmpty) return _variable.computeDocumentationComment();
1966+
if (docs.isEmpty) return _variable.documentationComment;
19671967
return docs;
19681968
}
19691969

@@ -2001,7 +2001,6 @@ class Typedef extends ModelElement implements EnclosedElement {
20012001

20022002
String get nameWithGenerics {
20032003
if (!modelType.isParameterizedType) return name;
2004-
String n = '$name<${_typeParameters.map((t) => t.name).join(', ')}>';
20052004
return '$name<${_typeParameters.map((t) => t.name).join(', ')}>';
20062005
}
20072006

pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: dartdoc
22
# Also update the `version` field in lib/dartdoc.dart.
3-
version: 0.8.5
3+
version: 0.8.5-dev
44
author: Dart Team <[email protected]>
55
description: A documentation generator for Dart.
66
homepage: https://github.com/dart-lang/dartdoc

test_package_docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
66
<meta name="viewport" content="width=device-width, initial-scale=1">
7-
<meta name="generator" content="made with love by dartdoc 0.8.5">
7+
<meta name="generator" content="made with love by dartdoc 0.8.5-dev">
88
<meta name="description" content="test_package API docs, for the Dart programming language.">
99
<title>test_package - Dart API docs</title>
1010

0 commit comments

Comments
 (0)