Skip to content

Commit 8e9d89e

Browse files
authored
Remove all @deprecated elements. (dart-lang#3250)
1 parent 2019791 commit 8e9d89e

23 files changed

+27
-300
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
## 7.0.0-dev
2+
3+
* Remove all `@deprecated` elements.
4+
* Remove deprecated `<nodoc>` syntax.
5+
16
## 6.3.0
27
* Add a hideImplementations directive to disable showing constant
38
implementations alongside one-line docs on class pages (#3398)

dartdoc_options.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
dartdoc:
22
linkToSource:
33
root: '.'
4-
uriTemplate: 'https://github.com/dart-lang/dartdoc/blob/v6.3.0/%f%#L%l%'
4+
uriTemplate: 'https://github.com/dart-lang/dartdoc/blob/v7.0.0-dev/%f%#L%l%'

lib/dartdoc.dart

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,8 @@ library dartdoc;
77

88
export 'package:dartdoc/src/dartdoc.dart';
99
export 'package:dartdoc/src/dartdoc_options.dart';
10-
@Deprecated(
11-
'Elements which are only exposed via this export will no longer be part of '
12-
'the public API starting in dartdoc 7.0.0')
13-
export 'package:dartdoc/src/element_type.dart';
1410
export 'package:dartdoc/src/generator/generator.dart';
1511
export 'package:dartdoc/src/model/indexable.dart' show Kind;
16-
@Deprecated(
17-
'Elements which are only exposed via this export will no longer be part of '
18-
'the public API starting in dartdoc 7.0.0')
19-
export 'package:dartdoc/src/model/model.dart';
2012
export 'package:dartdoc/src/model/package_builder.dart';
2113
export 'package:dartdoc/src/model/package_graph.dart';
2214
export 'package:dartdoc/src/package_config_provider.dart';

lib/src/dartdoc_options.dart

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import 'package:args/args.dart';
2222
import 'package:dartdoc/src/experiment_options.dart';
2323
import 'package:dartdoc/src/failure.dart';
2424
import 'package:dartdoc/src/io_utils.dart';
25+
import 'package:dartdoc/src/model/model.dart';
2526
import 'package:dartdoc/src/package_meta.dart';
2627
import 'package:dartdoc/src/source_linker.dart';
2728
import 'package:dartdoc/src/tool_definition.dart';

lib/src/generator/dartdoc_generator_backend.dart

Lines changed: 0 additions & 6 deletions
This file was deleted.

lib/src/generator/generator_backend.dart

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,6 @@ import 'package:dartdoc/src/version.dart';
1414
import 'package:dartdoc/src/warnings.dart';
1515
import 'package:path/path.dart' as p show Context;
1616

17-
@Deprecated('Refer to GeneratorBackendBase directly')
18-
typedef DartdocGeneratorBackend = GeneratorBackendBase;
19-
2017
/// Configuration options for Dartdoc's default backend.
2118
class DartdocGeneratorBackendOptions implements TemplateOptions {
2219
@override

lib/src/generator/generator_frontend.dart

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,6 @@ import 'package:dartdoc/src/model_utils.dart';
1010
import 'package:dartdoc/src/runtime_stats.dart';
1111
import 'package:dartdoc/src/warnings.dart';
1212

13-
@Deprecated('Refer to GeneratorBackendBase directly')
14-
export 'package:dartdoc/src/generator/generator_backend.dart'
15-
show
16-
// ignore: deprecated_member_use_from_same_package
17-
DartdocGeneratorBackend;
18-
1913
/// A [Generator] that delegates rendering to a [GeneratorBackend] and delegates
2014
/// file creation to a [FileWriter].
2115
class GeneratorFrontEnd implements Generator {

lib/src/generator/template_data.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -262,8 +262,8 @@ class ClassTemplateData extends InheritingContainerTemplateData<Class> {
262262
);
263263

264264
@override
265-
// Mustachio generation requires this unnecessary override.
266-
// Likely a bug or serious missing feature in Mustachio.
265+
// Mustachio generation requires this unnecessary override. Likely a bug or
266+
// serious missing feature in Mustachio.
267267
// ignore: unnecessary_overrides
268268
Class get clazz => super.clazz;
269269
}

lib/src/generator/templates.runtime_renderers.dart

Lines changed: 0 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -5116,18 +5116,6 @@ class _Renderer_ExtensionTarget extends RendererBase<ExtensionTarget> {
51165116
parent: r);
51175117
},
51185118
),
5119-
'potentiallyApplicableExtensions': Property(
5120-
getValue: (CT_ c) => c.potentiallyApplicableExtensions,
5121-
renderVariable: (CT_ c, Property<CT_> self,
5122-
List<String> remainingNames) =>
5123-
self.renderSimpleVariable(
5124-
c, remainingNames, 'List<Extension>'),
5125-
renderIterable: (CT_ c, RendererBase<CT_> r,
5126-
List<MustachioNode> ast, StringSink sink) {
5127-
return c.potentiallyApplicableExtensions.map((e) =>
5128-
_render_Extension(e, ast, r.template, sink, parent: r));
5129-
},
5130-
),
51315119
'potentiallyApplicableExtensionsSorted': Property(
51325120
getValue: (CT_ c) => c.potentiallyApplicableExtensionsSorted,
51335121
renderVariable: (CT_ c, Property<CT_> self,
@@ -5762,19 +5750,6 @@ class _Renderer_Field extends RendererBase<Field> {
57625750
parent: r, getters: _invisibleGetters['Feature']!));
57635751
},
57645752
),
5765-
'field': Property(
5766-
getValue: (CT_ c) => c.field,
5767-
renderVariable: (CT_ c, Property<CT_> self,
5768-
List<String> remainingNames) =>
5769-
self.renderSimpleVariable(
5770-
c, remainingNames, 'FieldElement'),
5771-
isNullValue: (CT_ c) => c.field == null,
5772-
renderValue: (CT_ c, RendererBase<CT_> r,
5773-
List<MustachioNode> ast, StringSink sink) {
5774-
renderSimple(c.field, ast, r.template, sink,
5775-
parent: r, getters: _invisibleGetters['FieldElement']!);
5776-
},
5777-
),
57785753
'fileName': Property(
57795754
getValue: (CT_ c) => c.fileName,
57805755
renderVariable:
@@ -10783,13 +10758,6 @@ class _Renderer_ModelElement extends RendererBase<ModelElement> {
1078310758
_render_String(c.htmlId, ast, r.template, sink, parent: r);
1078410759
},
1078510760
),
10786-
'isAsynchronous': Property(
10787-
getValue: (CT_ c) => c.isAsynchronous,
10788-
renderVariable: (CT_ c, Property<CT_> self,
10789-
List<String> remainingNames) =>
10790-
self.renderSimpleVariable(c, remainingNames, 'bool'),
10791-
getBool: (CT_ c) => c.isAsynchronous == true,
10792-
),
1079310761
'isCallable': Property(
1079410762
getValue: (CT_ c) => c.isCallable,
1079510763
renderVariable: (CT_ c, Property<CT_> self,
@@ -10832,13 +10800,6 @@ class _Renderer_ModelElement extends RendererBase<ModelElement> {
1083210800
self.renderSimpleVariable(c, remainingNames, 'bool'),
1083310801
getBool: (CT_ c) => c.isEnumValue == true,
1083410802
),
10835-
'isExecutable': Property(
10836-
getValue: (CT_ c) => c.isExecutable,
10837-
renderVariable: (CT_ c, Property<CT_> self,
10838-
List<String> remainingNames) =>
10839-
self.renderSimpleVariable(c, remainingNames, 'bool'),
10840-
getBool: (CT_ c) => c.isExecutable == true,
10841-
),
1084210803
'isFinal': Property(
1084310804
getValue: (CT_ c) => c.isFinal,
1084410805
renderVariable: (CT_ c, Property<CT_> self,
@@ -10853,27 +10814,6 @@ class _Renderer_ModelElement extends RendererBase<ModelElement> {
1085310814
self.renderSimpleVariable(c, remainingNames, 'bool'),
1085410815
getBool: (CT_ c) => c.isLate == true,
1085510816
),
10856-
'isLocalElement': Property(
10857-
getValue: (CT_ c) => c.isLocalElement,
10858-
renderVariable: (CT_ c, Property<CT_> self,
10859-
List<String> remainingNames) =>
10860-
self.renderSimpleVariable(c, remainingNames, 'bool'),
10861-
getBool: (CT_ c) => c.isLocalElement == true,
10862-
),
10863-
'isPropertyAccessor': Property(
10864-
getValue: (CT_ c) => c.isPropertyAccessor,
10865-
renderVariable: (CT_ c, Property<CT_> self,
10866-
List<String> remainingNames) =>
10867-
self.renderSimpleVariable(c, remainingNames, 'bool'),
10868-
getBool: (CT_ c) => c.isPropertyAccessor == true,
10869-
),
10870-
'isPropertyInducer': Property(
10871-
getValue: (CT_ c) => c.isPropertyInducer,
10872-
renderVariable: (CT_ c, Property<CT_> self,
10873-
List<String> remainingNames) =>
10874-
self.renderSimpleVariable(c, remainingNames, 'bool'),
10875-
getBool: (CT_ c) => c.isPropertyInducer == true,
10876-
),
1087710817
'isPublic': Property(
1087810818
getValue: (CT_ c) => c.isPublic,
1087910819
renderVariable: (CT_ c, Property<CT_> self,
@@ -10888,13 +10828,6 @@ class _Renderer_ModelElement extends RendererBase<ModelElement> {
1088810828
self.renderSimpleVariable(c, remainingNames, 'bool'),
1088910829
getBool: (CT_ c) => c.isPublicAndPackageDocumented == true,
1089010830
),
10891-
'isStatic': Property(
10892-
getValue: (CT_ c) => c.isStatic,
10893-
renderVariable: (CT_ c, Property<CT_> self,
10894-
List<String> remainingNames) =>
10895-
self.renderSimpleVariable(c, remainingNames, 'bool'),
10896-
getBool: (CT_ c) => c.isStatic == true,
10897-
),
1089810831
'kind': Property(
1089910832
getValue: (CT_ c) => c.kind,
1090010833
renderVariable: (CT_ c, Property<CT_> self,
@@ -11040,29 +10973,6 @@ class _Renderer_ModelElement extends RendererBase<ModelElement> {
1104010973
parent: r);
1104110974
},
1104210975
),
11043-
'linkedParamsNoMetadataOrNames': Property(
11044-
getValue: (CT_ c) => c.linkedParamsNoMetadataOrNames,
11045-
renderVariable:
11046-
(CT_ c, Property<CT_> self, List<String> remainingNames) {
11047-
if (remainingNames.isEmpty) {
11048-
return self.getValue(c).toString();
11049-
}
11050-
var name = remainingNames.first;
11051-
var nextProperty =
11052-
_Renderer_String.propertyMap().getValue(name);
11053-
return nextProperty.renderVariable(
11054-
self.getValue(c) as String,
11055-
nextProperty,
11056-
[...remainingNames.skip(1)]);
11057-
},
11058-
isNullValue: (CT_ c) => false,
11059-
renderValue: (CT_ c, RendererBase<CT_> r,
11060-
List<MustachioNode> ast, StringSink sink) {
11061-
_render_String(
11062-
c.linkedParamsNoMetadataOrNames, ast, r.template, sink,
11063-
parent: r);
11064-
},
11065-
),
1106610976
'location': Property(
1106710977
getValue: (CT_ c) => c.location,
1106810978
renderVariable:
@@ -17109,7 +17019,6 @@ const _invisibleGetters = {
1710917019
'specialClasses'
1711017020
},
1711117021
'PackageMeta': {
17112-
'description',
1711317022
'dir',
1711417023
'hashCode',
1711517024
'homepage',
@@ -17118,7 +17027,6 @@ const _invisibleGetters = {
1711817027
'isValid',
1711917028
'name',
1712017029
'pathContext',
17121-
'repository',
1712217030
'requiresFlutter',
1712317031
'resolvedDir',
1712417032
'resourceProvider',

lib/src/markdown_processor.dart

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -234,11 +234,6 @@ const maxPriorContext = 20;
234234
/// generic.
235235
const maxPostContext = 30;
236236

237-
@Deprecated('Public access to this variable is deprecated')
238-
final allBeforeFirstNewline = _allBeforeFirstNewline;
239-
@Deprecated('Public access to this variable is deprecated')
240-
final allAfterLastNewline = _allAfterLastNewline;
241-
242237
final RegExp _allBeforeFirstNewline = RegExp(r'^.*\n', multiLine: true);
243238
final RegExp _allAfterLastNewline = RegExp(r'\n.*$', multiLine: true);
244239

@@ -308,28 +303,10 @@ class MarkdownDocument extends md.Document {
308303
);
309304
}
310305

311-
@Deprecated("MarkdownDocument's unnamed constructor is deprecated. Use "
312-
'[MarkdownDocument.withElementLinkResolver]')
313-
MarkdownDocument({
314-
Iterable<md.BlockSyntax>? blockSyntaxes,
315-
Iterable<md.InlineSyntax>? inlineSyntaxes,
316-
md.ExtensionSet? extensionSet,
317-
md.Resolver? linkResolver,
318-
md.Resolver? imageLinkResolver,
319-
}) : this._(
320-
blockSyntaxes: blockSyntaxes,
321-
inlineSyntaxes: inlineSyntaxes,
322-
extensionSet: extensionSet,
323-
linkResolver: linkResolver,
324-
imageLinkResolver: imageLinkResolver,
325-
);
326-
327306
MarkdownDocument._({
328307
super.blockSyntaxes,
329308
super.inlineSyntaxes,
330-
super.extensionSet,
331309
super.linkResolver,
332-
super.imageLinkResolver,
333310
});
334311

335312
/// Parses markdown text, collecting the first [md.Node] or all of them

lib/src/model/comment_referable.dart

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,6 @@ import 'package:dartdoc/src/model/model_object_builder.dart';
1919
import 'package:dartdoc/src/model/nameable.dart';
2020
import 'package:meta/meta.dart';
2121

22-
@Deprecated('Public access to this class is deprecated')
23-
typedef ReferenceChildrenLookup = _ReferenceChildrenLookup;
24-
2522
class _ReferenceChildrenLookup {
2623
final String lookup;
2724
final List<String> remaining;
@@ -130,7 +127,7 @@ mixin CommentReferable implements Nameable, ModelBuilderInterface {
130127
allowTree: allowTree, filter: filter);
131128
}
132129

133-
/// Given a [result] found in an implementation of [lookupViaScope] or
130+
/// Given a [result] found in an implementation of [_lookupViaScope] or
134131
/// [_ReferenceChildrenLookup], recurse through children, skipping over
135132
/// results that do not match the filter.
136133
CommentReferable? _recurseChildrenAndFilter(
@@ -157,11 +154,6 @@ mixin CommentReferable implements Nameable, ModelBuilderInterface {
157154
return returnValue;
158155
}
159156

160-
@Deprecated('Public access to this method is deprecated')
161-
// ignore: library_private_types_in_public_api
162-
Iterable<_ReferenceChildrenLookup> childLookups(List<String> reference) =>
163-
_childLookups(reference);
164-
165157
/// A list of lookups that should be attempted on children based on
166158
/// [reference].
167159
///
@@ -174,7 +166,7 @@ mixin CommentReferable implements Nameable, ModelBuilderInterface {
174166
reference.sublist(index + 1)))
175167
.toList(growable: false);
176168

177-
/// Map of [referenceName] to the elements that are a member of [this], but
169+
/// Map of [referenceName] to the elements that are a member of `this`, but
178170
/// not this model element itself. Can be cached.
179171
///
180172
/// There is no need to duplicate references here that can be found via
@@ -202,10 +194,9 @@ mixin CommentReferable implements Nameable, ModelBuilderInterface {
202194
// TODO(jcollins-g): Eliminate need for this in markdown_processor.
203195
Library? get library => null;
204196

205-
@internal
206-
207197
/// For testing / comparison only, get the comment referable from where this
208-
/// [ElementType] was defined. Override where an [Element] is available.
198+
/// `ElementType` was defined. Override where an [Element] is available.
199+
@internal
209200
CommentReferable get definingCommentReferable => this;
210201
}
211202

lib/src/model/extension_target.dart

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,12 @@ mixin ExtensionTarget on ModelElement {
1919
/// This is defined as those extensions where an instantiation of the type
2020
/// defined by [element] can exist where this extension applies, not including
2121
/// any extension that applies to every type.
22-
@Deprecated('Use potentiallyApplicableExtensionsSorted')
23-
late final List<Extension> potentiallyApplicableExtensions = packageGraph
24-
.documentedExtensions
25-
.where((e) => !e.alwaysApplies)
26-
.where((e) => e.couldApplyTo(this))
27-
.toList(growable: false)
28-
..sort(byName);
22+
late final List<Extension> potentiallyApplicableExtensionsSorted =
23+
packageGraph.documentedExtensions
24+
.where((e) => !e.alwaysApplies)
25+
.where((e) => e.couldApplyTo(this))
26+
.toList(growable: false)
27+
..sort(byName);
2928

3029
ElementType get modelType;
31-
32-
List<Extension> get potentiallyApplicableExtensionsSorted =>
33-
// ignore: deprecated_member_use_from_same_package
34-
potentiallyApplicableExtensions;
3530
}

lib/src/model/field.dart

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,6 @@ class Field extends ModelElement
104104
@override
105105
bool get isInherited => _isInherited;
106106

107-
@override
108107
bool get isStatic => element.isStatic;
109108

110109
@override
@@ -141,9 +140,6 @@ class Field extends ModelElement
141140
return allFeatures;
142141
}
143142

144-
@Deprecated('Use `element`')
145-
FieldElement? get field => element;
146-
147143
@override
148144
String get fileName =>
149145
'${isConst ? '$name-constant' : name}.${fileStructure.fileType}';

lib/src/model/method.dart

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,6 @@ class Method extends ModelElement
9595
if (isInherited) Feature.inherited,
9696
};
9797

98-
@override
9998
bool get isStatic => element.isStatic;
10099

101100
@override

0 commit comments

Comments
 (0)