X Tutup
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 0 additions & 72 deletions docs/docs-package/templates/type-definition.template.html

This file was deleted.

1 change: 1 addition & 0 deletions docs/typescript-definition-package/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ module.exports = new Package('angular-v2-docs', [jsdocPackage, nunjucksPackage,
{
id: 'angular2/router',
references: ['./angular2.d.ts'],
remapTypes: {Type: 'ng.Type'},
modules: {
'angular2/router': {
namespace: 'ngRouter',
Expand Down
40 changes: 40 additions & 0 deletions docs/typescript-definition-package/processors/code_gen.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
module.exports = {

signature: function(remap) {
return function(ast) {
try {
var text = [];
if (ast.isStatic) text.push('static ');
text.push(ast.name);
if (ast.optional) text.push('?');
if (ast.typeParameters) {
text.push('<');
text.push(ast.typeParameters.join(', '));
text.push('>');
}
if (ast.parameters) {
text.push('(');
text.push(ast.parameters.join(', '));
text.push(')');
}
if (ast.returnType) {
text.push(': ', ast.returnType);
} else if (ast.parameters) {
text.push(': void');
} else {
text.push(': any');
}
var string = text.join('');
for (var key in remap) {
if (remap.hasOwnProperty(key)) {
string = string.replace(new RegExp('\\b' + key + '\\b', 'gm'), remap[key]);
}
}
return string;
} catch (e) {
console.log(e.toString(), e.stack);
return 'ERROR: ' + e.toString();
}
}
}
};
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
var _ = require('lodash');
var path = require('canonical-path');
var codeGen = require('./code_gen.js');

module.exports = function createTypeDefinitionFile(log) {

Expand Down Expand Up @@ -31,15 +32,17 @@ module.exports = function createTypeDefinitionFile(log) {
path: docPath,
outputPath: docPath,
// A type definition may include a number of top level modules
// And those modules could be aliased (such as 'angular2/angular2.api' -> 'angular2/angular2')
moduleDocs: _.transform(def.modules, function(moduleDocs, props, alias) {
moduleDocs[props.id] = {
id: alias,
doc: null,
namespace: props.namespace,
references: def.references
};
})
// And those modules could be aliased (such as 'angular2/angular2.api' ->
// 'angular2/angular2')
moduleDocs: _.transform(def.modules,
function(moduleDocs, props, alias) {
moduleDocs[props.id] = {
id: alias,
doc: null, namespace: props.namespace,
references: def.references
};
}),
signature: codeGen.signature(def.remapTypes)
};
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,9 @@
{%- endmacro -%}


{%- macro memberInfo(member) -%}
{%- macro memberInfo(signature, member) -%}
{$ commentBlock(member, 5) $}
{% if member.isStatic -%}static {% endif -%}{$ member.name $}{% if member.optional %}?{% endif -%}
{% if member.typeParameters %}<{% for typeParam in member.typeParameters %}{$ typeParam $}{% if not loop.last %}, {% endif %}{% endfor %}>{% endif -%}
{%- if member.parameters -%}({% for param in member.parameters %}{$ param $}{% if not loop.last %}, {% endif %}{% endfor %}){%- endif -%}
{%- if member.returnType -%}
: {$ member.returnType $}
{%- elif member.parameters -%}
: void
{%- else -%}
: any
{%- endif -%};
{$ signature(member) $};
{%- endmacro -%}


Expand Down Expand Up @@ -53,16 +44,16 @@
{$ export.docType $} {$ export.name $}{$ export.typeParams $}{%- if export.heritage == ' extends Directive' %} extends DirectiveAnnotation{% else %}{$ export.heritage $}{% endif %}
{%- if export.docType == 'class' or export.docType == 'interface' %} {
{%- if export.newMember %}
{$ memberInfo(export.newMember) $}
{$ memberInfo(doc.signature, export.newMember) $}
{% endif %}
{%- if export.callMember %}
{$ memberInfo(export.callMember) $}
{$ memberInfo(doc.signature, export.callMember) $}
{% endif -%}
{%- for static in export.statics %}
{$ memberInfo(static) $}
{$ memberInfo(doc.signature, static) $}
{%- endfor -%}
{%- for member in export.members %}
{$ memberInfo(member) $}
{$ memberInfo(doc.signature, member) $}
{%- endfor %}
}

Expand Down
2 changes: 1 addition & 1 deletion modules/angular2/router.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export {OnActivate, OnDeactivate, OnReuse, CanDeactivate, CanReuse} from './src/
export {CanActivate} from './src/router/lifecycle_annotations';
export {Instruction, ComponentInstruction} from './src/router/instruction';
export {Url} from './src/router/url_parser';
export {OpaqueToken, Type} from 'angular2/angular2';
export {OpaqueToken} from 'angular2/angular2';
export {ROUTE_DATA} from './src/router/route_data';

import {LocationStrategy} from './src/router/location_strategy';
Expand Down
X Tutup