Skip to content

Commit ada0600

Browse files
authored
Migrate the renderers to NNBD (#2816)
* Migrate renderers * dartfmt
1 parent 5e86e84 commit ada0600

12 files changed

+13
-42
lines changed

lib/src/model/language_feature.dart

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
// for details. All rights reserved. Use of this source code is governed by a
33
// BSD-style license that can be found in the LICENSE file.
44

5-
// @dart=2.9
6-
75
import 'package:dartdoc/src/render/language_feature_renderer.dart';
86

97
const Map<String, String> _featureDescriptions = {
@@ -18,11 +16,11 @@ const Map<String, String> _featureUrls = {
1816
/// the user that the documentation should be specially interpreted.
1917
class LanguageFeature {
2018
/// The description of this language feature.
21-
String get featureDescription => _featureDescriptions[name];
19+
String? get featureDescription => _featureDescriptions[name];
2220

2321
/// A URL containing more information about this feature or `null` if there
2422
/// is none.
25-
String /*?*/ get featureUrl => _featureUrls[name];
23+
String? get featureUrl => _featureUrls[name];
2624

2725
/// The rendered label for this language feature.
2826
String get featureLabel => _featureRenderer.renderLanguageFeatureLabel(this);

lib/src/render/category_renderer.dart

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
// for details. All rights reserved. Use of this source code is governed by a
33
// BSD-style license that can be found in the LICENSE file.
44

5-
// @dart=2.9
6-
75
import 'package:dartdoc/src/model/category.dart';
86

97
/// A renderer for a [Category].

lib/src/render/documentation_renderer.dart

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,13 @@
22
// for details. All rights reserved. Use of this source code is governed by a
33
// BSD-style license that can be found in the LICENSE file.
44

5-
// @dart=2.9
6-
75
import 'package:html/parser.dart' show parse;
86
import 'package:markdown/markdown.dart' as md;
9-
import 'package:meta/meta.dart';
107

118
abstract class DocumentationRenderer {
129
DocumentationRenderResult render(
1310
List<md.Node> nodes, {
14-
@required bool processFullDocs,
11+
required bool processFullDocs,
1512
});
1613
}
1714

@@ -21,7 +18,7 @@ class DocumentationRendererHtml implements DocumentationRenderer {
2118
@override
2219
DocumentationRenderResult render(
2320
List<md.Node> nodes, {
24-
@required bool processFullDocs,
21+
required bool processFullDocs,
2522
}) {
2623
if (nodes.isEmpty) {
2724
return DocumentationRenderResult.empty;
@@ -51,11 +48,10 @@ class DocumentationRendererHtml implements DocumentationRenderer {
5148
if (processFullDocs) {
5249
// `trim` fixes an issue with line ending differences between Mac and
5350
// Windows.
54-
asHtml = asHtmlDocument.body.innerHtml?.trim();
51+
asHtml = (asHtmlDocument.body?.innerHtml ?? '').trim();
5552
}
56-
var asOneLiner = asHtmlDocument.body.children.isEmpty
57-
? ''
58-
: asHtmlDocument.body.children.first.innerHtml;
53+
var children = asHtmlDocument.body?.children ?? [];
54+
var asOneLiner = children.isEmpty ? '' : children.first.innerHtml;
5955

6056
return DocumentationRenderResult(asHtml: asHtml, asOneLiner: asOneLiner);
6157
}
@@ -68,5 +64,5 @@ class DocumentationRenderResult {
6864
final String asOneLiner;
6965

7066
const DocumentationRenderResult(
71-
{@required this.asHtml, @required this.asOneLiner});
67+
{required this.asHtml, required this.asOneLiner});
7268
}

lib/src/render/enum_field_renderer.dart

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
// for details. All rights reserved. Use of this source code is governed by a
33
// BSD-style license that can be found in the LICENSE file.
44

5-
// @dart=2.9
6-
75
import 'package:dartdoc/src/model/enum.dart';
86

97
abstract class EnumFieldRenderer {

lib/src/render/feature_renderer.dart

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
// for details. All rights reserved. Use of this source code is governed by a
33
// BSD-style license that can be found in the LICENSE file.
44

5-
// @dart=2.9
6-
75
import 'dart:convert';
86

97
import 'package:dartdoc/src/model/annotation.dart';

lib/src/render/language_feature_renderer.dart

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
// for details. All rights reserved. Use of this source code is governed by a
33
// BSD-style license that can be found in the LICENSE file.
44

5-
// @dart=2.9
6-
75
import 'package:dartdoc/src/model/language_feature.dart';
86

97
/// A renderer for a [LanguageFeature].

lib/src/render/model_element_renderer.dart

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
// for details. All rights reserved. Use of this source code is governed by a
33
// BSD-style license that can be found in the LICENSE file.
44

5-
// @dart=2.9
6-
75
import 'package:dartdoc/src/model/feature.dart';
86
import 'package:dartdoc/src/model/model_element.dart';
97

lib/src/render/parameter_renderer.dart

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,10 @@
22
// for details. All rights reserved. Use of this source code is governed by a
33
// BSD-style license that can be found in the LICENSE file.
44

5-
// @dart=2.9
6-
75
import 'dart:convert';
86

9-
import 'package:analyzer/dart/element/type.dart';
107
import 'package:dartdoc/src/element_type.dart';
118
import 'package:dartdoc/src/model/parameter.dart';
12-
import 'package:meta/meta.dart' as meta;
139

1410
/// Render HTML in an extended vertical format using <ol> tag.
1511
class ParameterRendererHtmlList extends ParameterRendererHtml {
@@ -136,7 +132,7 @@ abstract class ParameterRenderer {
136132

137133
void _renderLinkedParameterSublist(
138134
List<Parameter> parameters, StringBuffer output,
139-
{@meta.required bool trailingComma,
135+
{required bool trailingComma,
140136
String openBracket = '',
141137
String closeBracket = '',
142138
bool showMetadata = true,
@@ -164,8 +160,8 @@ abstract class ParameterRenderer {
164160

165161
String _renderParam(
166162
Parameter param, {
167-
@meta.required String prefix,
168-
@meta.required String suffix,
163+
required String prefix,
164+
required String suffix,
169165
bool showMetadata = true,
170166
bool showNames = true,
171167
}) {
@@ -195,8 +191,7 @@ abstract class ParameterRenderer {
195191
buf.write(typeName(returnTypeName));
196192
if (showNames) {
197193
buf.write(' ${parameterName(param.name)}');
198-
} else if (paramModelType.isTypedef ||
199-
paramModelType.type is FunctionType) {
194+
} else {
200195
buf.write(' ${parameterName(paramModelType.name)}');
201196
}
202197
if (!paramModelType.isTypedef && paramModelType is DefinedElementType) {
@@ -208,7 +203,7 @@ abstract class ParameterRenderer {
208203
buf.write(')');
209204
buf.write(paramModelType.nullabilitySuffix);
210205
}
211-
if (!paramModelType.isTypedef && paramModelType.type is FunctionType) {
206+
if (!paramModelType.isTypedef) {
212207
buf.write('(');
213208
buf.write(renderLinkedParams(paramModelType.parameters,
214209
showMetadata: showMetadata, showNames: showNames));

lib/src/render/source_code_renderer.dart

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
// for details. All rights reserved. Use of this source code is governed by a
33
// BSD-style license that can be found in the LICENSE file.
44

5-
// @dart=2.9
6-
75
import 'dart:convert';
86

97
/// Renderer for source code snippets extracted from source files.

lib/src/render/template_renderer.dart

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
// for details. All rights reserved. Use of this source code is governed by a
33
// BSD-style license that can be found in the LICENSE file.
44

5-
// @dart=2.9
6-
75
abstract class LayoutRenderer {
86
String composeLayoutTitle(String name, String kind, bool isDeprecated);
97
}

lib/src/render/type_parameters_renderer.dart

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
// for details. All rights reserved. Use of this source code is governed by a
33
// BSD-style license that can be found in the LICENSE file.
44

5-
// @dart=2.9
6-
75
import 'package:dartdoc/src/model/type_parameter.dart';
86

97
abstract class TypeParametersRenderer {

lib/src/render/typedef_renderer.dart

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
// for details. All rights reserved. Use of this source code is governed by a
33
// BSD-style license that can be found in the LICENSE file.
44

5-
// @dart=2.9
6-
75
import 'package:dartdoc/src/model/type_parameter.dart';
86
import 'package:dartdoc/src/model/typedef.dart';
97

0 commit comments

Comments
 (0)