Skip to content

Commit 191b538

Browse files
committed
Silly little cleanup
Don't use triple-slashes except when documenting members - started Spelling
1 parent b41afc5 commit 191b538

File tree

7 files changed

+27
-27
lines changed

7 files changed

+27
-27
lines changed

lib/src/asset/reader.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@ abstract class AssetReader {
1818
/// Gets a [Stream<AssetId>] of all assets available matching [inputSets].
1919
Stream<AssetId> listAssetIds(Iterable<InputSet> inputSets);
2020

21-
/// Asynchonously gets the last modified [DateTime] of [id].
21+
/// Asynchronously gets the last modified [DateTime] of [id].
2222
Future<DateTime> lastModified(AssetId id);
2323
}

lib/src/builder/build_step_impl.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ class BuildStepImpl implements BuildStep {
119119
}
120120

121121
/// Checks that [asset] is a valid output, and throws an
122-
/// [InvalidOutputException] or [UnexcpectedOutputException] if it's not.
122+
/// [InvalidOutputException] or [UnexpectedOutputException] if it's not.
123123
void _checkOutput(Asset asset) {
124124
if (asset.id.package != _rootPackage) {
125125
throw new InvalidOutputException(asset);

lib/src/generate/build.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Future<BuildResult> build(PhaseGroup phaseGroup,
8282
/// The [directoryWatcherFactory] allows you to inject a way of creating custom
8383
/// [DirectoryWatcher]s. By default a normal [DirectoryWatcher] will be used.
8484
///
85-
/// The [teminateEventStream] is a stream which can send termination events.
85+
/// The [terminateEventStream] is a stream which can send termination events.
8686
/// By default the [ProcessSignal.SIGINT] stream is used. In this mode, the
8787
/// first event will allow any ongoing builds to finish, and then the program
8888
/// will complete normally. Subsequent events are not handled (and will
@@ -175,7 +175,7 @@ Stream<BuildResult> serve(PhaseGroup phaseGroup,
175175
}
176176

177177
/// Given [terminateEventStream], call [onTerminate] the first time an event is
178-
/// seen. If a second event is recieved, simply exit.
178+
/// seen. If a second event is received, simply exit.
179179
StreamSubscription _setupTerminateLogic(
180180
Stream terminateEventStream, Future onTerminate(),
181181
{Future cancelWhen}) {

lib/src/generate/build_impl.dart

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -191,8 +191,8 @@ class BuildImpl {
191191
return new AssetGraph.deserialize(
192192
JSON.decode(await _reader.readAsString(_assetGraphId)));
193193
} on AssetGraphVersionException catch (_) {
194-
/// Start fresh if the cached asset_graph version doesn't match up with
195-
/// the current version. We don't currently support old graph versions.
194+
// Start fresh if the cached asset_graph version doesn't match up with
195+
// the current version. We don't currently support old graph versions.
196196
_logger.info('Throwing away cached asset graph due to version mismatch.');
197197
return new AssetGraph();
198198
}
@@ -207,7 +207,7 @@ class BuildImpl {
207207
var completer = new Completer<bool>();
208208
Future
209209
.wait(currentMirrorSystem().libraries.keys.map((Uri uri) async {
210-
/// Short-circuit
210+
// Short-circuit
211211
if (completer.isCompleted) return;
212212
var lastModified;
213213
switch (uri.scheme) {
@@ -223,14 +223,14 @@ class BuildImpl {
223223
break;
224224
case 'file':
225225

226-
/// TODO(jakemac): Probably shouldn't use dart:io directly, but its
227-
/// definitely the easiest solution and should be fine.
226+
// TODO(jakemac): Probably shouldn't use dart:io directly, but its
227+
// definitely the easiest solution and should be fine.
228228
var file = new File.fromUri(uri);
229229
lastModified = await file.lastModified();
230230
break;
231231
case 'data':
232232

233-
/// Test runner uses a `data` scheme, don't invalidate for those.
233+
// Test runner uses a `data` scheme, don't invalidate for those.
234234
if (uri.path.contains('package:test')) return;
235235
continue unknownUri;
236236
unknownUri: default:
@@ -252,7 +252,7 @@ class BuildImpl {
252252

253253
/// Creates and returns a map of updates to assets based on [_assetGraph].
254254
Future<Map<AssetId, ChangeType>> _getUpdates() async {
255-
/// Collect updates to the graph based on any changed assets.
255+
// Collect updates to the graph based on any changed assets.
256256
var updates = <AssetId, ChangeType>{};
257257
await Future.wait(_assetGraph.allNodes
258258
.where((node) =>
@@ -294,11 +294,11 @@ class BuildImpl {
294294
(_reader as CachedAssetReader).evictFromCache(id);
295295
}
296296

297-
/// Update all ouputs of this asset as well.
297+
// Update all outputs of this asset as well.
298298
await Future.wait(node.outputs.map((output) =>
299299
clearNodeAndDeps(output, rootChangeType, parent: node.id)));
300300

301-
/// For deletes, prune the graph.
301+
// For deletes, prune the graph.
302302
if (parent == null && rootChangeType == ChangeType.REMOVE) {
303303
_assetGraph.remove(id);
304304
}
@@ -322,8 +322,8 @@ class BuildImpl {
322322
await _writer.delete(_assetGraphId);
323323
_inputsByPackage[_assetGraphId.package]?.remove(_assetGraphId);
324324

325-
/// Remove all output nodes from [_inputsByPackage], and delete all assets
326-
/// that need updates.
325+
// Remove all output nodes from [_inputsByPackage], and delete all assets
326+
// that need updates.
327327
await Future.wait(_assetGraph.allNodes
328328
.where((node) => node is GeneratedAssetNode)
329329
.map((node) async {
@@ -361,16 +361,16 @@ class BuildImpl {
361361
}
362362
}
363363

364-
/// Once the group is done, add all outputs so they can be used in the next
365-
/// phase.
364+
// Once the group is done, add all outputs so they can be used in the next
365+
// phase.
366366
for (var outputId in groupOutputIds) {
367367
tempInputsByPackage.putIfAbsent(
368368
outputId.package, () => new Set<AssetId>());
369369
tempInputsByPackage[outputId.package].add(outputId);
370370
}
371371
}
372372

373-
// Check conflictingOuputs, prompt user to delete files.
373+
// Check conflictingOutputs, prompt user to delete files.
374374
if (conflictingOutputs.isEmpty) return;
375375

376376
Future deleteConflictingOutputs() {
@@ -432,10 +432,10 @@ class BuildImpl {
432432
Future<BuildResult> _runPhases() async {
433433
final outputs = <Asset>[];
434434
for (var phase in _buildActions) {
435-
/// Collects all the ids for files which are output by this stage. This
436-
/// also includes files which didn't get regenerated because they weren't,
437-
/// dirty unlike [outputs] which only gets files which were explicitly
438-
/// generated in this build.
435+
// Collects all the ids for files which are output by this stage. This
436+
// also includes files which didn't get regenerated because they weren't,
437+
// dirty unlike [outputs] which only gets files which were explicitly
438+
// generated in this build.
439439
final phaseOutputIds = new Set<AssetId>();
440440

441441
await Future.wait(phase.map((action) async {

lib/src/generate/options.dart

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,18 @@ import 'directory_watcher_factory.dart';
1717

1818
/// Manages setting up consistent defaults for all options and build modes.
1919
class BuildOptions {
20-
/// Build mode options.
20+
// Build mode options.
2121
StreamSubscription logListener;
2222
PackageGraph packageGraph;
2323
AssetReader reader;
2424
AssetWriter writer;
2525
bool deleteFilesByDefault;
2626

27-
/// Watch mode options.
27+
// Watch mode options.
2828
Duration debounceDelay;
2929
DirectoryWatcherFactory directoryWatcherFactory;
3030

31-
/// Server options.
31+
// Server options.
3232
int port;
3333
String address;
3434
String directory;

lib/src/logging/logging.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import 'package:logging/logging.dart';
88

99
/// Calls [logger#info] with [description] before and after calling [action]
1010
/// and waiting for the returned future to complete. The 2nd log message will
11-
/// have the ellapsed time appended.
11+
/// have the elapsed time appended.
1212
///
1313
/// This function also appends a newline after the 2nd log (unless on windows)
1414
/// to ensure that it does not get overwritten by later log messages.

test/generate/watch_test.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ main() {
177177
ChangeType.MODIFY, path.absolute('a', 'web', 'a.txt')));
178178

179179
result = await nextResult(results);
180-
// Ignores the modifcation under the `b` package, even though it
180+
// Ignores the modification under the `b` package, even though it
181181
// matches the input set.
182182
checkOutputs({'a|web/a.txt.copy': 'b',}, result, writer.assets);
183183
});

0 commit comments

Comments
 (0)