With this change, dartdoc does a more comprehensive job of letting users
navigate the web of types. For each class, this will show its chain of
superclasses, interfaces it implements, and its immediate subclasses.
For interfaces, it shows superinterfaces, subinterfaces, implementing classes,
and a default class if it has one.
Review URL: https://chromiumcodereview.appspot.com//9271020
git-svn-id: https://dart.googlecode.com/svn/branches/bleeding_edge/dart@3515 260f80e4-7a28-3924-810f-c04153c831b5
Right now, the generated docs are pretty huge (100MB for all of the main libs). This is mainly
because each generated HTML page includes full navigation for each type in the containing
library. For stuff like dart:html, that's tons of HTML. Even after compression, the docs are
9.2MB. Also, they take a long time to generate (30s on my laptop).
This patch adds a mode you can use called "live-nav" (and makes it the default). With that
mode, pages do not include navigation. Instead, we generate a single nav.json file with the
navigation data. Client-side Dart code does an XHR for that and then renders the navigation
on the fly.
This gets the generated docs down to 13.3MB (2MB after compression) and gets doc generation
up to 6.3s for everything.
The two downsides are:
1. There's a visible flash on page load when it renders the nav since it's asynchronous.
2. You can't browse docs locally just using file://. To be able to XHR the nav.json, you
either need to enable file access in your browser or run a local server.
Review URL: https://chromiumcodereview.appspot.com//9256002
git-svn-id: https://dart.googlecode.com/svn/branches/bleeding_edge/dart@3445 260f80e4-7a28-3924-810f-c04153c831b5
This moves markdown into two places:
- The one under samples/ is intended to be a "real" markdown parser.
Eventually, it will probably live as a third-party library outside of our
standard lib but still easily accessible.
- The one inside dartdoc will change to become the parser used to parse
Gilad's forthcoming dartdoc comment syntax.
Review URL: http://codereview.chromium.org//8953042
git-svn-id: https://dart.googlecode.com/svn/branches/bleeding_edge/dart@2606 260f80e4-7a28-3924-810f-c04153c831b5
This entails adding callbacks to dartdoc for injecting additional
comments, as well as adding somewhat deeper support for hashing and
equality testing of Frog objects.
The next step is to inject the annotations into the HTML and DOM library source itself.
Review URL: http://codereview.chromium.org//8771054
git-svn-id: https://dart.googlecode.com/svn/branches/bleeding_edge/dart@2199 260f80e4-7a28-3924-810f-c04153c831b5
- Remove "Library" from libraries in index.
- Use different icon for exception classes in nav.
- Group classes, interfaces, and exceptions together on lib page.
- Don't show "Class" or "Interface" before types on lib pages.
- Show type bounds on generic classes.
- Don't show private constructors.
- Sort named constructors.
- Document function-typed parameters correctly. (See Collection<T>)
- Document named optional parameters and default values.
- Document type bounds in class definitions.
- Show raw types without type arguments.
- In type annotations for instantiated generic types, link the type
argument appropriately (i.e. List<String> will link String>).
git-svn-id: https://dart.googlecode.com/svn/branches/bleeding_edge/dart@2159 260f80e4-7a28-3924-810f-c04153c831b5
This also writes everything to an index.html inside an appropriate
directory. This keeps the URLs nice and pretty like: core_lib/String.
The downside is that you'll need to run a little local web server
to get them to be served up right instead of just opening them as
files in your browser.
Review URL: http://codereview.chromium.org//8758010
git-svn-id: https://dart.googlecode.com/svn/branches/bleeding_edge/dart@2031 260f80e4-7a28-3924-810f-c04153c831b5
- Add support for [foo] implicit links to markdown.
- Add hook so that outside code can define what markup a [foo] link creates.
- Make dartdoc look up [foo] names to resolve the identifier.
- Fix unmatched tag unwinding bug.
- Add [:...:] code support to dartdoc.
- Fix text and URLs for generic types in docs.
- Sort classes by name.
- Don't generate docs for private types.
- Fix generated docs for inheritance chain.
- Make source code in generated docs optional.
- Fix showing base class in docs.
- Implement insertRange() for List in frog.
- Add dartdoc shell script.
Review URL: http://codereview.chromium.org//8725007
git-svn-id: https://dart.googlecode.com/svn/branches/bleeding_edge/dart@1886 260f80e4-7a28-3924-810f-c04153c831b5