Google Git
Sign in
dart / dartdoc / 94e7d97ccc1a833e2022a26ce957315b96e1ccd4
commit94e7d97ccc1a833e2022a26ce957315b96e1ccd4[log] [tgz]
authorSeth Ladd <sethladd@google.com>Thu Aug 13 15:18:01 2015 -0700
committerSeth Ladd <sethladd@google.com>Thu Aug 13 15:18:01 2015 -0700
tree1548b1d3daeb2884f98a6210bc05411c7c27e663
parentf29c8f9adaeeeb35aa154d7e20afadb93bdfd926 [diff]
Removes workaround when sorting an empty iterable

Closes #789

Squashed commit of the following:

commit 1fa3aa793a00ac32fcf9292a3d4af13795e92fc2
Merge: ff4e679 f29c8f9
Author: Seth Ladd <sethladd@google.com>
Date:   Thu Aug 13 15:17:35 2015 -0700

    Merge branch 'master' of github.com:dart-lang/dartdoc into sl-undo-workaround

commit ff4e679357860ced9f0b35e1d41c01580796d1f9
Author: Seth Ladd <sethladd@google.com>
Date:   Fri Aug 7 12:56:35 2015 -0700

    WIP

commit 1997e7dafa63c1ace887c20c42b8055b01c5d7a2
Merge: 044451d ce9b4cd
Author: Seth Ladd <sethladd@google.com>
Date:   Fri Aug 7 12:43:04 2015 -0700

    Merge branch 'master' of github.com:dart-lang/dartdoc into sl-undo-workaround

commit 044451dd91c956738c5d5826ca73598b13ab54d8
Author: Seth Ladd <sethladd@google.com>
Date:   Fri Aug 7 12:41:43 2015 -0700

    remove workaround
1 file changed
tree: 1548b1d3daeb2884f98a6210bc05411c7c27e663
  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.