a8533b2133
This commit enables links to other docs, such as classes and modules,
via the `{@link CodeIdentifier}` style inline tag.
Dgeni identifies what you are linking to by comparing the identifier to the
aliases for each doc. If no alias matches the identifier then the dgeni
run exits with a missing doc in link error. If more than one alias matches
the identifier then dgeni exits with an ambiguous link error.
In the future we could build in some heuristics for choosing a preferred
doc when the link is ambiguous, such as choosing a public doc over a
non-public doc; and choosing a code component that is in the same module as
the doc where the link is found.
Currently there are two aliases for each API component: its name and its
identier. For example, if the `Directive` class is exported from
`angular2/annotations`, so its aliases are 'Directive' and
`angular2/annotations.Directive`.
There is an issue in the non-public doc generation, which means that it
does not yet have `{@link}` tags implemented. This is that when we re-export
a code component, it gets cloned into another module. This means that a
simple reference to the code component's name will always produce an
ambiguous link. This can be fixed with a heuristic as described above.
Meanwhile you can avoid this by always using the full id of the code
component if it is being re-exported.
Closes #1371
Closes #1421
Angular 
Angular is a development platform for building mobile and desktop web applications. This is the repository for Angular 2, both the JavaScript (JS) and Dart versions.
Angular 2 is currently in Alpha Preview. We recommend using Angular 1.X for production applications:
Setup & Install Angular 2
Follow the instructions given on the Angular download page.
Want to help?
Want to file a bug, or contribute some code or improve documentation? Excellent! Read up on our guidelines for contributing.
Examples
To see the examples, first build the project as described here.
Hello World Example
This example consists of three basic pieces - a component, a decorator and a
service. They are all constructed via injection. For more information see the
comments in the source modules/examples/src/hello_world/index.js.
You can build this example as either JS or Dart app:
- JS:
$(npm bin)/gulp build.js.dev, and$(npm bin)/gulp serve.js.dev, and- open
localhost:8000/examples/src/hello_world/in Chrome.
- Dart:
$(npm bin)/gulp serve/examples.dart, and- open
localhost:8080/src/hello_worldin Chrome (for dart2js) or Dartium (for Dart VM).