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).
4 files changed
tree: 5319d4e2f785aa1f85907c0e71e4819dd0e4bd66
  1. lib/
  2. test/
  3. tool/
  4. .gitignore
  5. .travis.yml
  6. analysis_options.yaml
  10. data.csv
  12. pubspec.yaml
  13. README.md

This library contains getters for useful Unicode glyphs as well as plain ASCII alternatives. It‘s intended to be used in command-line applications that may run in places where Unicode isn’t well-supported and libraries that may be used by those applications.

We recommend that you import this library with the prefix “glyph”. For example:

import 'package:term_glyph/term_glyph.dart' as glyph;

/// Formats [items] into a bulleted list, with one item per line.
String bulletedList(List<String> items) =>
    items.map((item) => "${glyph.bullet} $item").join("\n");


Some shells are unable to display Unicode characters, so this package is able to transparently switch its glyphs to ASCII alternatives by setting the ascii attribute. When this attribute is true, all glyphs use ASCII characters instead. It currently defaults to false, although in the future it may default to true for applications running on the Dart VM on Windows. For example:

import 'dart:io';

import 'package:term_glyph/term_glyph.dart' as glyph;

void main() {
  glyph.ascii = Platform.isWindows;

  // Prints "Unicode => ASCII" on Windows, "Unicode ━▶ ASCII" everywhere else.
  print("Unicode ${glyph.rightArrow} ASCII");

All ASCII glyphs are guaranteed to be the same number of characters as the corresponding Unicode glyphs, so that they line up properly when printed on a terminal. The specific ASCII text for a given Unicode glyph may change over time; this is not considered a breaking change.