26 Commits

Author SHA1 Message Date
Peter Bacon Darwin
0c282e826a chore(doc-gen): ensure github links have the correct text 2015-06-15 21:59:52 +01:00
Jacob Eggers
8112b0baa7 chore(doc-gen): fix versionInfo population 2015-06-15 21:51:45 +01:00
Peter Bacon Darwin
659adf83dc chore(doc-gen): move typeParams and heritage rendering to template
Partially solves 
2015-06-11 19:15:17 +01:00
Peter Bacon Darwin
efab03274f chore(doc-gen): autogenerate Angular version in angular.d.ts file 2015-06-10 12:42:24 +01:00
Alex Eagle
7141c15e65 fix(docs): Working generated angular2.d.ts
This requires some hacks, documented in
https://docs.google.com/document/d/1nNebWTiLzz5ePcit_bjZPtaiSIFU4EsQKUlX7LX0c0A/edit

Changes:
- include subtyping info in angular2.d.ts by adding 'extends supertype'
- export missing symbols needed transitively by angular2/angular2
- because of decorator/annotation mismatch, we can't export these to applications.
  So I've added a separate angular2.api.ts file to re-export specifically to .d.ts
  generation.
- Hack to remove aliases introduced by 'import * as alias' syntax
- Hack to deal with Error still an interface

note that we require users to install the transitive dependencies - this is how TSD works.
2015-06-05 15:33:23 -07:00
Alex Eagle
f303f0c17a chore(docs): remove private members from angular2.d.ts 2015-06-02 17:15:49 -07:00
Peter Bacon Darwin
1fae8d6377 chore(doc-gen): add template for const docTypes 2015-06-02 15:30:03 -07:00
Alex Eagle
e67b7e87b2 chore(docs): Improve whitespace and semicolons in angular2.d.ts 2015-06-02 15:29:07 -07:00
Peter Bacon Darwin
a504fa835e chore(doc-gen): improve github links to point to the correct tagged URL
Closes 
2015-06-02 10:56:23 +01:00
Peter Bacon Darwin
f6eeb9aa66 chore(doc-gen): dgenerate the type definition file for angular2
Closes 
Closes 
2015-05-20 12:23:59 +01:00
Peter Bacon Darwin
50c6efa187 chore(doc-gen): fix paths for links to modules and exports 2015-05-19 14:38:10 +01:00
Peter Bacon Darwin
b6b9ede425 chore(doc-gen): include interfaces in the possible exports from a module 2015-05-19 14:38:10 +01:00
Peter Bacon Darwin
9a72f19b97 chore(doc-gen): add TypeScript parsing 2015-05-19 14:38:08 +01:00
Peter Bacon Darwin
fbd6851860 chore(doc-gen): add ids to members to allow direct linking
You can now write a link to a member of a class by appending the member name
to the class name joined by a hash sign:

```
{@link ControlGroupDirective#addDirective `addDirective`}
```

By default the link will contain the text of the class rather than the member
so you must add it as an inline code text snippet in the link tag.

Closes 
2015-04-18 22:06:49 +01:00
Peter Bacon Darwin
e1b0bab9a6 chore(doc-gen): ignore members marked with @private 2015-04-17 16:24:07 +01:00
Peter Bacon Darwin
0658d5602e chore(doc-gen): ignore exports marked as @private
Closes 
2015-04-15 19:50:01 -07:00
Peter Bacon Darwin
b5002fb46b docs(test_lib/test_injector): fix invalid jsdoc type
chore(doc-gen): capture docs for modules from comments

Closes 

docs(*): add module description jsdoc tags
docs(*): add @public tag to public modules
chore(doc-gen): fix overview-dump template
The template was referencing an invalid property
chore(doc-gen): use `@exportedAs` and `@public` rather than `@publicModule`

This commit refactors how we describe components that are re-exported in another
module. For example the "public" modules like `angular/angular` and `angular/annotations`
are public but they only re-export components from "private" modules.

Previously, you must apply the `@publicModule` tag to a component that was to be
re-exported. Applying this tag caused the destination module to become public.

Now, you specify that a module is public by applying the `@public` tag and then
you can "re-export" components to other modules by applying the `@exportedAs`
giving the name of the module from which the component will be re-exported.
tag. This tag can be used multiple times on a single component, allowing the
component to be exported on multiple modules.

docs(*): rename `@publicModule` to `@exportedAs`

The `@publicModule` dgeni tag has been replaced by the `@exportedAs`
dgeni tag on components that are to be re-exported on another module.

Closes 
2015-04-10 22:00:41 +00:00
Peter Bacon Darwin
9f8a9c6fc7 chore(doc-gen): ensure all public exports are rendered in public_docs
Closes 
2015-04-08 18:58:44 +02:00
Peter Bacon Darwin
105ba30ce9 chore(doc-gen): improve method signature formatting
Re-use the preformatting from the source code to layout method signatures
more cleanly.
2015-04-08 17:11:34 +02:00
Peter Bacon Darwin
ee8bf0b3c0 chore(doc-gen): HTML escape method signatures
Closes 
Closes 
2015-04-08 17:11:34 +02:00
Peter Bacon Darwin
1a99090b45 chore(doc-gen): don't show Members heading if no members
Closes 
2015-04-07 09:23:19 +02:00
Peter Bacon Darwin
27c6afbeb4 chore(doc-gen): add temporary dump of all API docs
Remove unwanted < character
2015-04-01 10:24:33 +01:00
Peter Bacon Darwin
adab6c0728 chore(doc-gen): add temporary dump of all API docs
Accessible at `angular/dist/public_docs/overview-dump.html`
2015-03-31 22:12:41 +01:00
Peter Bacon Darwin
609201e109 chore(doc-gen): add method signatures to members and functions
Closes https://github.com/angular/dgeni/issues/124
2015-03-31 22:12:41 +01:00
Peter Bacon Darwin
539e8e2cce chore(doc-gen): add specific template for displaying variable exports
Closes 
2015-03-24 10:57:42 +00:00
Peter Bacon Darwin
27e03591dd chore(docs): initial dgeni docs generation
Closes 
2014-12-04 14:17:08 +00:00