Skip to content

Commit 41ca816

Browse files
authored
General cleanup (#1516)
* Use one StringBuffer, make it private and final * Move PackageWarningCounter into its own file * dartfmt * Make packageWarningText const * Remove unnecessary indirection of sets * _writeWarning cleanup * Update dependencies - including latest markdown, etc * Put braces on conditional * Cleanup nameAndLocation Tuple
1 parent 693fd88 commit 41ca816

12 files changed

+408
-368
lines changed

analysis_options.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,5 @@ linter:
1515
- no_adjacent_strings_in_list
1616
- package_api_docs
1717
- slash_for_doc_comments
18+
- prefer_final_fields
1819
# - unnecessary_brace_in_string_interps

lib/dartdoc.dart

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ import 'src/io_utils.dart';
3636
import 'src/model.dart';
3737
import 'src/model_utils.dart';
3838
import 'src/package_meta.dart';
39+
import 'src/warnings.dart';
3940

4041
export 'src/config.dart';
4142
export 'src/element_type.dart';
@@ -107,15 +108,14 @@ class DartDoc {
107108
final Set<String> writtenFiles = new Set();
108109

109110
// Fires when the self checks make progress.
110-
StreamController<String> _onCheckProgress;
111+
final StreamController<String> _onCheckProgress =
112+
new StreamController(sync: true);
111113

112114
Stopwatch _stopwatch;
113115

114116
DartDoc(this.rootDir, this.excludes, this.sdkDir, this.generators,
115117
this.outputDir, this.packageMeta, this.includes,
116-
{this.includeExternals: const []}) {
117-
_onCheckProgress = new StreamController(sync: true);
118-
}
118+
{this.includeExternals: const []});
119119

120120
Stream<String> get onCheckProgress => _onCheckProgress.stream;
121121

lib/src/config.dart

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44

55
library dartdoc.config;
66

7-
import 'dart:collection' show UnmodifiableListView;
87
import 'dart:io';
98

109
class Config {
@@ -46,10 +45,8 @@ void setConfig(
4645
bool autoIncludeDependencies: false,
4746
List<String> categoryOrder,
4847
double reexportMinConfidence: 0.1,
49-
verboseWarnings: true,
48+
bool verboseWarnings: true,
5049
List<String> dropTextFrom}) {
51-
categoryOrder ??= new UnmodifiableListView<String>([]);
52-
dropTextFrom ??= new UnmodifiableListView<String>([]);
5350
_config = new Config._(
5451
inputDir,
5552
showWarnings,
@@ -58,8 +55,8 @@ void setConfig(
5855
includeSource,
5956
sdkVersion,
6057
autoIncludeDependencies,
61-
categoryOrder,
58+
categoryOrder ?? const <String>[],
6259
reexportMinConfidence,
6360
verboseWarnings,
64-
dropTextFrom);
61+
dropTextFrom ?? const <String>[]);
6562
}

lib/src/html/html_generator_instance.dart

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import 'package:collection/collection.dart' show compareNatural;
1111
import 'package:path/path.dart' as path;
1212

1313
import '../model.dart';
14+
import '../warnings.dart';
1415
import 'html_generator.dart' show HtmlGeneratorOptions;
1516
import 'resource_loader.dart' as loader;
1617
import 'resources.g.dart' as resources;

lib/src/markdown_processor.dart

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ import 'package:markdown/markdown.dart' as md;
1616
import 'package:tuple/tuple.dart';
1717

1818
import 'model.dart';
19+
import 'warnings.dart';
1920

2021
const validHtmlTags = const [
2122
"a",

0 commit comments

Comments
 (0)