don't print ellipsis if thing is inherited
Closes #849

Squashed commit of the following:

commit 1ec615881f599d7ba9c3453184806d53a94139a1
Author: Seth Ladd <sethladd@google.com>
Date:   Fri Aug 21 16:45:27 2015 -0700

    don't print ellipsis if thing is inherited

commit 2ced991706f5283c66083529c5deae79736cfca8
Author: Seth Ladd <sethladd@google.com>
Date:   Fri Aug 21 16:43:50 2015 -0700

    don't print an ellipsis of method is inherited

commit 1ba738d15321f152b780566cc97b2c1dfd103d12
Author: Seth Ladd <sethladd@google.com>
Date:   Fri Aug 21 16:31:50 2015 -0700

    add ellipsis when there's more beyond a one-liner
11 files changed
tree: 87cbe42261e61fc934996ddee02e3c9fdd56e70f
  1. bin/
  2. example/
  3. lib/
  4. test/
  5. test_package/
  6. test_package_bad/
  7. test_package_not_valid/
  8. test_package_small/
  9. tool/
  10. .analysis_options
  11. .gitignore
  12. .project
  13. .travis.yml
  14. appveyor.yml
  15. AUTHORS
  16. CHANGELOG.md
  17. firebase.json
  18. LICENSE
  19. pubspec.lock
  20. pubspec.yaml
  21. README.md
README.md

dartdoc

A documentation generator for Dart. This tool creates static HTML files generated from Dart source code.

Build Status Build status Coverage Status

Installing dartdoc

Run pub global activate dartdoc to install dartdoc.

Running dartdoc

Run dartdoc from the root directory of package. By default, the documentation is generated to the doc/api/ directory.

Status

Ready for testing, but has known issues.

FAQ

What about docgen / dartdocgen / dartdoc-viewer?

This tool intends to replace our existing set of API documentation tools. We'll take the best ideas and implementations from our existing doc tools and fold them into dartdoc.

Can I help?

Yes! Start by using the tool and filing issues and requests. If you want to contribute, check out the issue tracker and see if there‘s an issue that you’re passionate about. If you want to add a new feature that's not yet in the issue tracker, start by opening an issue. Thanks!

What does the output look like?

You can see the latest API of dartdoc - generated by dartdoc - here.

Generating documentation for Dart SDK

If you want to generate documentation for the SDK, run dartdoc with the following command line arguments:

  • --sdk-docs
  • --dart-sdk /pathTo/dart-sdk (optional)

Issues and bugs

Please file reports on the GitHub Issue Tracker.

License

You can view our license here.