From bb99fa4e19eb7633d3c64c9d57c4aba384f68574 Mon Sep 17 00:00:00 2001 From: Nate Bosch Date: Wed, 11 Dec 2019 17:17:53 -0800 Subject: [PATCH] Drop the doc comments on overrides (#10) These classes are not public and so the docs don't show up on the pub site. Even if they did show up the comments as is only duplicate the information from the interface (which dartdoc would show anyway) and the implementation (which dartdoc also shows). --- lib/src/generated/ascii_glyph_set.dart | 246 ----------------------- lib/src/generated/unicode_glyph_set.dart | 246 ----------------------- pubspec.yaml | 2 +- tool/generate.dart | 6 - 4 files changed, 1 insertion(+), 499 deletions(-) diff --git a/lib/src/generated/ascii_glyph_set.dart b/lib/src/generated/ascii_glyph_set.dart index c233bf5..e0c3a49 100644 --- a/lib/src/generated/ascii_glyph_set.dart +++ b/lib/src/generated/ascii_glyph_set.dart @@ -14,370 +14,124 @@ class AsciiGlyphSet implements GlyphSet { /// otherwise. @override String glyphOrAscii(String glyph, String alternative) => alternative; - - /// A bullet point. - /// - /// Always '*' for [this]. @override String get bullet => '*'; - - /// A left-pointing arrow. - /// - /// Note that the Unicode arrow glyphs may overlap with adjacent characters in some - /// terminal fonts, and should generally be surrounding by spaces. - /// - /// Always '<' for [this]. @override String get leftArrow => '<'; - - /// A right-pointing arrow. - /// - /// Note that the Unicode arrow glyphs may overlap with adjacent characters in some - /// terminal fonts, and should generally be surrounding by spaces. - /// - /// Always '>' for [this]. @override String get rightArrow => '>'; - - /// An upwards-pointing arrow. - /// - /// Always '^' for [this]. @override String get upArrow => '^'; - - /// A downwards-pointing arrow. - /// - /// Always 'v' for [this]. @override String get downArrow => 'v'; - - /// A two-character left-pointing arrow. - /// - /// Always '<=' for [this]. @override String get longLeftArrow => '<='; - - /// A two-character right-pointing arrow. - /// - /// Always '=>' for [this]. @override String get longRightArrow => '=>'; - - /// A horizontal line that can be used to draw a box. - /// - /// Always '-' for [this]. @override String get horizontalLine => '-'; - - /// A vertical line that can be used to draw a box. - /// - /// Always '|' for [this]. @override String get verticalLine => '|'; - - /// The upper left-hand corner of a box. - /// - /// Always ',' for [this]. @override String get topLeftCorner => ','; - - /// The upper right-hand corner of a box. - /// - /// Always ',' for [this]. @override String get topRightCorner => ','; - - /// The lower left-hand corner of a box. - /// - /// Always "'" for [this]. @override String get bottomLeftCorner => "'"; - - /// The lower right-hand corner of a box. - /// - /// Always "'" for [this]. @override String get bottomRightCorner => "'"; - - /// An intersection of vertical and horizontal box lines. - /// - /// Always '+' for [this]. @override String get cross => '+'; - - /// A horizontal box line with a vertical line going up from the middle. - /// - /// Always '+' for [this]. @override String get teeUp => '+'; - - /// A horizontal box line with a vertical line going down from the middle. - /// - /// Always '+' for [this]. @override String get teeDown => '+'; - - /// A vertical box line with a horizontal line going left from the middle. - /// - /// Always '+' for [this]. @override String get teeLeft => '+'; - - /// A vertical box line with a horizontal line going right from the middle. - /// - /// Always '+' for [this]. @override String get teeRight => '+'; - - /// The top half of a vertical box line. - /// - /// Always "'" for [this]. @override String get upEnd => "'"; - - /// The bottom half of a vertical box line. - /// - /// Always ',' for [this]. @override String get downEnd => ','; - - /// The left half of a horizontal box line. - /// - /// Always '-' for [this]. @override String get leftEnd => '-'; - - /// The right half of a horizontal box line. - /// - /// Always '-' for [this]. @override String get rightEnd => '-'; - - /// A bold horizontal line that can be used to draw a box. - /// - /// Always '=' for [this]. @override String get horizontalLineBold => '='; - - /// A bold vertical line that can be used to draw a box. - /// - /// Always '|' for [this]. @override String get verticalLineBold => '|'; - - /// The bold upper left-hand corner of a box. - /// - /// Always ',' for [this]. @override String get topLeftCornerBold => ','; - - /// The bold upper right-hand corner of a box. - /// - /// Always ',' for [this]. @override String get topRightCornerBold => ','; - - /// The bold lower left-hand corner of a box. - /// - /// Always "'" for [this]. @override String get bottomLeftCornerBold => "'"; - - /// The bold lower right-hand corner of a box. - /// - /// Always "'" for [this]. @override String get bottomRightCornerBold => "'"; - - /// An intersection of bold vertical and horizontal box lines. - /// - /// Always '+' for [this]. @override String get crossBold => '+'; - - /// A bold horizontal box line with a vertical line going up from the middle. - /// - /// Always '+' for [this]. @override String get teeUpBold => '+'; - - /// A bold horizontal box line with a vertical line going down from the middle. - /// - /// Always '+' for [this]. @override String get teeDownBold => '+'; - - /// A bold vertical box line with a horizontal line going left from the middle. - /// - /// Always '+' for [this]. @override String get teeLeftBold => '+'; - - /// A bold vertical box line with a horizontal line going right from the middle. - /// - /// Always '+' for [this]. @override String get teeRightBold => '+'; - - /// The top half of a bold vertical box line. - /// - /// Always "'" for [this]. @override String get upEndBold => "'"; - - /// The bottom half of a bold vertical box line. - /// - /// Always ',' for [this]. @override String get downEndBold => ','; - - /// The left half of a bold horizontal box line. - /// - /// Always '-' for [this]. @override String get leftEndBold => '-'; - - /// The right half of a bold horizontal box line. - /// - /// Always '-' for [this]. @override String get rightEndBold => '-'; - - /// A double horizontal line that can be used to draw a box. - /// - /// Always '=' for [this]. @override String get horizontalLineDouble => '='; - - /// A double vertical line that can be used to draw a box. - /// - /// Always '|' for [this]. @override String get verticalLineDouble => '|'; - - /// The double upper left-hand corner of a box. - /// - /// Always ',' for [this]. @override String get topLeftCornerDouble => ','; - - /// The double upper right-hand corner of a box. - /// - /// Always ',' for [this]. @override String get topRightCornerDouble => ','; - - /// The double lower left-hand corner of a box. - /// - /// Always '"' for [this]. @override String get bottomLeftCornerDouble => '"'; - - /// The double lower right-hand corner of a box. - /// - /// Always '"' for [this]. @override String get bottomRightCornerDouble => '"'; - - /// An intersection of double vertical and horizontal box lines. - /// - /// Always '+' for [this]. @override String get crossDouble => '+'; - - /// A double horizontal box line with a vertical line going up from the middle. - /// - /// Always '+' for [this]. @override String get teeUpDouble => '+'; - - /// A double horizontal box line with a vertical line going down from the middle. - /// - /// Always '+' for [this]. @override String get teeDownDouble => '+'; - - /// A double vertical box line with a horizontal line going left from the middle. - /// - /// Always '+' for [this]. @override String get teeLeftDouble => '+'; - - /// A double vertical box line with a horizontal line going right from the middle. - /// - /// Always '+' for [this]. @override String get teeRightDouble => '+'; - - /// A dashed horizontal line that can be used to draw a box. - /// - /// Always '-' for [this]. @override String get horizontalLineDoubleDash => '-'; - - /// A bold dashed horizontal line that can be used to draw a box. - /// - /// Always '-' for [this]. @override String get horizontalLineDoubleDashBold => '-'; - - /// A dashed vertical line that can be used to draw a box. - /// - /// Always '|' for [this]. @override String get verticalLineDoubleDash => '|'; - - /// A bold dashed vertical line that can be used to draw a box. - /// - /// Always '|' for [this]. @override String get verticalLineDoubleDashBold => '|'; - - /// A dashed horizontal line that can be used to draw a box. - /// - /// Always '-' for [this]. @override String get horizontalLineTripleDash => '-'; - - /// A bold dashed horizontal line that can be used to draw a box. - /// - /// Always '-' for [this]. @override String get horizontalLineTripleDashBold => '-'; - - /// A dashed vertical line that can be used to draw a box. - /// - /// Always '|' for [this]. @override String get verticalLineTripleDash => '|'; - - /// A bold dashed vertical line that can be used to draw a box. - /// - /// Always '|' for [this]. @override String get verticalLineTripleDashBold => '|'; - - /// A dashed horizontal line that can be used to draw a box. - /// - /// Always '-' for [this]. @override String get horizontalLineQuadrupleDash => '-'; - - /// A bold dashed horizontal line that can be used to draw a box. - /// - /// Always '-' for [this]. @override String get horizontalLineQuadrupleDashBold => '-'; - - /// A dashed vertical line that can be used to draw a box. - /// - /// Always '|' for [this]. @override String get verticalLineQuadrupleDash => '|'; - - /// A bold dashed vertical line that can be used to draw a box. - /// - /// Always '|' for [this]. @override String get verticalLineQuadrupleDashBold => '|'; } diff --git a/lib/src/generated/unicode_glyph_set.dart b/lib/src/generated/unicode_glyph_set.dart index bc6ad33..1737b39 100644 --- a/lib/src/generated/unicode_glyph_set.dart +++ b/lib/src/generated/unicode_glyph_set.dart @@ -14,370 +14,124 @@ class UnicodeGlyphSet implements GlyphSet { /// otherwise. @override String glyphOrAscii(String glyph, String alternative) => glyph; - - /// A bullet point. - /// - /// Always '•' for [this]. @override String get bullet => '•'; - - /// A left-pointing arrow. - /// - /// Note that the Unicode arrow glyphs may overlap with adjacent characters in some - /// terminal fonts, and should generally be surrounding by spaces. - /// - /// Always '←' for [this]. @override String get leftArrow => '←'; - - /// A right-pointing arrow. - /// - /// Note that the Unicode arrow glyphs may overlap with adjacent characters in some - /// terminal fonts, and should generally be surrounding by spaces. - /// - /// Always '→' for [this]. @override String get rightArrow => '→'; - - /// An upwards-pointing arrow. - /// - /// Always '↑' for [this]. @override String get upArrow => '↑'; - - /// A downwards-pointing arrow. - /// - /// Always '↓' for [this]. @override String get downArrow => '↓'; - - /// A two-character left-pointing arrow. - /// - /// Always '◀━' for [this]. @override String get longLeftArrow => '◀━'; - - /// A two-character right-pointing arrow. - /// - /// Always '━▶' for [this]. @override String get longRightArrow => '━▶'; - - /// A horizontal line that can be used to draw a box. - /// - /// Always '─' for [this]. @override String get horizontalLine => '─'; - - /// A vertical line that can be used to draw a box. - /// - /// Always '│' for [this]. @override String get verticalLine => '│'; - - /// The upper left-hand corner of a box. - /// - /// Always '┌' for [this]. @override String get topLeftCorner => '┌'; - - /// The upper right-hand corner of a box. - /// - /// Always '┐' for [this]. @override String get topRightCorner => '┐'; - - /// The lower left-hand corner of a box. - /// - /// Always '└' for [this]. @override String get bottomLeftCorner => '└'; - - /// The lower right-hand corner of a box. - /// - /// Always '┘' for [this]. @override String get bottomRightCorner => '┘'; - - /// An intersection of vertical and horizontal box lines. - /// - /// Always '┼' for [this]. @override String get cross => '┼'; - - /// A horizontal box line with a vertical line going up from the middle. - /// - /// Always '┴' for [this]. @override String get teeUp => '┴'; - - /// A horizontal box line with a vertical line going down from the middle. - /// - /// Always '┬' for [this]. @override String get teeDown => '┬'; - - /// A vertical box line with a horizontal line going left from the middle. - /// - /// Always '┤' for [this]. @override String get teeLeft => '┤'; - - /// A vertical box line with a horizontal line going right from the middle. - /// - /// Always '├' for [this]. @override String get teeRight => '├'; - - /// The top half of a vertical box line. - /// - /// Always '╵' for [this]. @override String get upEnd => '╵'; - - /// The bottom half of a vertical box line. - /// - /// Always '╷' for [this]. @override String get downEnd => '╷'; - - /// The left half of a horizontal box line. - /// - /// Always '╴' for [this]. @override String get leftEnd => '╴'; - - /// The right half of a horizontal box line. - /// - /// Always '╶' for [this]. @override String get rightEnd => '╶'; - - /// A bold horizontal line that can be used to draw a box. - /// - /// Always '━' for [this]. @override String get horizontalLineBold => '━'; - - /// A bold vertical line that can be used to draw a box. - /// - /// Always '┃' for [this]. @override String get verticalLineBold => '┃'; - - /// The bold upper left-hand corner of a box. - /// - /// Always '┏' for [this]. @override String get topLeftCornerBold => '┏'; - - /// The bold upper right-hand corner of a box. - /// - /// Always '┓' for [this]. @override String get topRightCornerBold => '┓'; - - /// The bold lower left-hand corner of a box. - /// - /// Always '┗' for [this]. @override String get bottomLeftCornerBold => '┗'; - - /// The bold lower right-hand corner of a box. - /// - /// Always '┛' for [this]. @override String get bottomRightCornerBold => '┛'; - - /// An intersection of bold vertical and horizontal box lines. - /// - /// Always '╋' for [this]. @override String get crossBold => '╋'; - - /// A bold horizontal box line with a vertical line going up from the middle. - /// - /// Always '┻' for [this]. @override String get teeUpBold => '┻'; - - /// A bold horizontal box line with a vertical line going down from the middle. - /// - /// Always '┳' for [this]. @override String get teeDownBold => '┳'; - - /// A bold vertical box line with a horizontal line going left from the middle. - /// - /// Always '┫' for [this]. @override String get teeLeftBold => '┫'; - - /// A bold vertical box line with a horizontal line going right from the middle. - /// - /// Always '┣' for [this]. @override String get teeRightBold => '┣'; - - /// The top half of a bold vertical box line. - /// - /// Always '╹' for [this]. @override String get upEndBold => '╹'; - - /// The bottom half of a bold vertical box line. - /// - /// Always '╻' for [this]. @override String get downEndBold => '╻'; - - /// The left half of a bold horizontal box line. - /// - /// Always '╸' for [this]. @override String get leftEndBold => '╸'; - - /// The right half of a bold horizontal box line. - /// - /// Always '╺' for [this]. @override String get rightEndBold => '╺'; - - /// A double horizontal line that can be used to draw a box. - /// - /// Always '═' for [this]. @override String get horizontalLineDouble => '═'; - - /// A double vertical line that can be used to draw a box. - /// - /// Always '║' for [this]. @override String get verticalLineDouble => '║'; - - /// The double upper left-hand corner of a box. - /// - /// Always '╔' for [this]. @override String get topLeftCornerDouble => '╔'; - - /// The double upper right-hand corner of a box. - /// - /// Always '╗' for [this]. @override String get topRightCornerDouble => '╗'; - - /// The double lower left-hand corner of a box. - /// - /// Always '╚' for [this]. @override String get bottomLeftCornerDouble => '╚'; - - /// The double lower right-hand corner of a box. - /// - /// Always '╝' for [this]. @override String get bottomRightCornerDouble => '╝'; - - /// An intersection of double vertical and horizontal box lines. - /// - /// Always '╬' for [this]. @override String get crossDouble => '╬'; - - /// A double horizontal box line with a vertical line going up from the middle. - /// - /// Always '╩' for [this]. @override String get teeUpDouble => '╩'; - - /// A double horizontal box line with a vertical line going down from the middle. - /// - /// Always '╦' for [this]. @override String get teeDownDouble => '╦'; - - /// A double vertical box line with a horizontal line going left from the middle. - /// - /// Always '╣' for [this]. @override String get teeLeftDouble => '╣'; - - /// A double vertical box line with a horizontal line going right from the middle. - /// - /// Always '╠' for [this]. @override String get teeRightDouble => '╠'; - - /// A dashed horizontal line that can be used to draw a box. - /// - /// Always '╌' for [this]. @override String get horizontalLineDoubleDash => '╌'; - - /// A bold dashed horizontal line that can be used to draw a box. - /// - /// Always '╍' for [this]. @override String get horizontalLineDoubleDashBold => '╍'; - - /// A dashed vertical line that can be used to draw a box. - /// - /// Always '╎' for [this]. @override String get verticalLineDoubleDash => '╎'; - - /// A bold dashed vertical line that can be used to draw a box. - /// - /// Always '╏' for [this]. @override String get verticalLineDoubleDashBold => '╏'; - - /// A dashed horizontal line that can be used to draw a box. - /// - /// Always '┄' for [this]. @override String get horizontalLineTripleDash => '┄'; - - /// A bold dashed horizontal line that can be used to draw a box. - /// - /// Always '┅' for [this]. @override String get horizontalLineTripleDashBold => '┅'; - - /// A dashed vertical line that can be used to draw a box. - /// - /// Always '┆' for [this]. @override String get verticalLineTripleDash => '┆'; - - /// A bold dashed vertical line that can be used to draw a box. - /// - /// Always '┇' for [this]. @override String get verticalLineTripleDashBold => '┇'; - - /// A dashed horizontal line that can be used to draw a box. - /// - /// Always '┈' for [this]. @override String get horizontalLineQuadrupleDash => '┈'; - - /// A bold dashed horizontal line that can be used to draw a box. - /// - /// Always '┉' for [this]. @override String get horizontalLineQuadrupleDashBold => '┉'; - - /// A dashed vertical line that can be used to draw a box. - /// - /// Always '┊' for [this]. @override String get verticalLineQuadrupleDash => '┊'; - - /// A bold dashed vertical line that can be used to draw a box. - /// - /// Always '┋' for [this]. @override String get verticalLineQuadrupleDashBold => '┋'; } diff --git a/pubspec.yaml b/pubspec.yaml index 29ea7d6..9c650e3 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,5 +1,5 @@ name: term_glyph -version: 1.1.0 +version: 1.1.1-dev description: Useful Unicode glyphs and ASCII substitutes. author: Dart Team diff --git a/tool/generate.dart b/tool/generate.dart index 04a919b..6e18536 100644 --- a/tool/generate.dart +++ b/tool/generate.dart @@ -110,13 +110,7 @@ void _writeGlyphSet(List data, {@required bool ascii}) { var index = ascii ? 2 : 1; for (var glyph in data) { - for (var line in glyph[3].split('\n')) { - file.writeStringSync('/// $line\n'); - } - file.writeStringSync(''' - /// - /// Always ${_quote(glyph[index])} for [this]. @override String get ${glyph[0]} => ${_quote(glyph[index])}; ''');