From bca12882be621cee4411cdc0529c83b428027b90 Mon Sep 17 00:00:00 2001 From: Sam Rawlins Date: Fri, 13 Oct 2023 10:12:56 -0700 Subject: [PATCH] Fix broken comment references (#89) * Fix broken comment references * feedback --- .gitignore | 1 + lib/src/characters.dart | 9 ++++----- lib/src/characters_impl.dart | 6 +++--- tool/src/atsp.dart | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.gitignore b/.gitignore index 49ce72d..2d72f2b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ .dart_tool/ .packages pubspec.lock +doc/api/ diff --git a/lib/src/characters.dart b/lib/src/characters.dart index a020674..4aa7d75 100644 --- a/lib/src/characters.dart +++ b/lib/src/characters.dart @@ -49,8 +49,8 @@ abstract class Characters implements Iterable { /// Returns [CharacterRange] positioned after the last character /// of this [Characters]. /// - /// Allows iterating the characters of [string] backwards - /// using [CharacterRange.movePrevious], + /// Allows iterating the characters of [string] backwards using + /// [CharacterRange.moveBack], /// as well as controlling the iteration in more detail. CharacterRange get iteratorAtEnd; @@ -62,7 +62,7 @@ abstract class Characters implements Iterable { /// and that character is one of the characters /// in this character sequence, and false otherwise. /// This behavior is inherited from `Iterable`, - /// which is why it is not [Character] based. + /// which is why it is not [Characters]-based. /// Use [containsAll] for a method which acts like /// [String.contains] for characters. @override @@ -390,8 +390,7 @@ abstract class CharacterRange implements Iterator { /// The copy is in the exact same state as this iterator. /// Can be used to iterate the following characters more than once /// at the same time. To simply rewind an iterator, remember the - /// [start] or [end] position and use [reset] to reset the iterator - /// to that position. + /// start or end position and use reset the iterator to that position. CharacterRange copy(); /// Whether the current range is empty. diff --git a/lib/src/characters_impl.dart b/lib/src/characters_impl.dart index e94b3d1..eb8cef4 100644 --- a/lib/src/characters_impl.dart +++ b/lib/src/characters_impl.dart @@ -464,15 +464,15 @@ class StringCharacterRange implements CharacterRange { /// Creates a [Breaks] from [_end] to `_string.length`. /// - /// Uses information stored in [_state] for cases where the next - /// character has already been seen. + /// Uses information stored in the state for cases where the next character + /// has already been seen. Breaks _breaksFromEnd() { return Breaks(_string, _end, _string.length, stateSoTNoBreak); } /// Creates a [Breaks] from string start to [_start]. /// - /// Uses information stored in [_state] for cases where the previous + /// Uses information stored in the state for cases where the previous /// character has already been seen. BackBreaks _backBreaksFromStart() { return BackBreaks(_string, _start, 0, stateEoTNoBreak); diff --git a/tool/src/atsp.dart b/tool/src/atsp.dart index 5ccd333..a62374d 100644 --- a/tool/src/atsp.dart +++ b/tool/src/atsp.dart @@ -12,7 +12,7 @@ /// An asymmetric weighted complete graph. /// -/// The vertices are identified by numbers 0 through [vertices] - 1. +/// The vertices are identified by numbers 0 through [vertexCount] - 1. /// Edges are pairs of vertices. class Graph { /// Number of vertices.