Skip to content
This repository was archived by the owner on Dec 4, 2017. It is now read-only.

Commit 3f36815

Browse files
committed
chore(dart/api): enable rudimentary API doc generation for Dart
This is a first step of many that will incrementally introduce proper API docs for Dart.
1 parent 05864c2 commit 3f36815

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

gulpfile.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -472,7 +472,7 @@ gulp.task('build-docs', ['build-devguide-docs', 'build-api-docs', 'build-plunker
472472
// Stop zipping examples Feb 28, 2016
473473
//gulp.task('build-docs', ['build-devguide-docs', 'build-api-docs', 'build-plunkers', '_zip-examples']);
474474

475-
gulp.task('build-api-docs', ['build-js-api-docs', 'build-ts-api-docs', 'build-dart-cheatsheet']);
475+
gulp.task('build-api-docs', ['build-js-api-docs', 'build-ts-api-docs', 'build-dart-api-docs']);
476476

477477
gulp.task('build-devguide-docs', ['_shred-devguide-examples', '_shred-devguide-shared-jade'], function() {
478478
return buildShredMaps(true);
@@ -486,12 +486,12 @@ gulp.task('build-js-api-docs', ['_shred-api-examples'], function() {
486486
return buildApiDocs('js');
487487
});
488488

489-
gulp.task('build-plunkers', ['_copy-example-boilerplate'], function() {
490-
return plunkerBuilder.buildPlunkers(EXAMPLES_PATH, LIVE_EXAMPLES_PATH, { errFn: gutil.log });
489+
gulp.task('build-dart-api-docs', ['_shred-api-examples'], function() {
490+
return buildApiDocs('dart');
491491
});
492492

493-
gulp.task('build-dart-cheatsheet', [], function() {
494-
return buildApiDocs('dart');
493+
gulp.task('build-plunkers', ['_copy-example-boilerplate'], function() {
494+
return plunkerBuilder.buildPlunkers(EXAMPLES_PATH, LIVE_EXAMPLES_PATH, { errFn: gutil.log });
495495
});
496496

497497
gulp.task('git-changed-examples', ['_shred-devguide-examples'], function(){
@@ -918,7 +918,7 @@ function apiSourceWatch(postBuildAction) {
918918
gutil.log('Event type: ' + event.event); // added, changed, or deleted
919919
gutil.log('Event path: ' + event.path); // The path of the modified file
920920

921-
return Q.all([buildApiDocs('ts'), buildApiDocs('js')]).then(postBuildAction);
921+
return Q.all([buildApiDocs('ts'), buildApiDocs('js'), buildApiDocs('dart')]).then(postBuildAction);
922922
});
923923
}
924924

@@ -972,7 +972,7 @@ function devGuideSharedJadeWatch(shredOptions, postShredAction) {
972972
// Generate the API docs for the specified language, if not specified then it defaults to ts
973973
function buildApiDocs(targetLanguage) {
974974
var ALLOWED_LANGUAGES = ['ts', 'js', 'dart'];
975-
var GENERATE_API_LANGUAGES = ['ts', 'js'];
975+
var GENERATE_API_LANGUAGES = ['ts', 'js', 'dart'];
976976
checkAngularProjectPath();
977977
try {
978978
// Build a specialized package to generate different versions of the API docs
Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
.l-main-section
2-
h2 Beta
1+
:marked
2+
> **Known issues:** Although this generated API reference displays Dart APIs
3+
and includes some Dart examples, the text reflects the TypeScript APIs. The
4+
angular.io issue tracker contains [all known issues][api-issues]; if you
5+
notice others, please [report them][ngio-issues]. Thanks!
36

4-
p.
5-
The proposed Angular 2 API does not yet have Dart-specific documentation.
6-
However, because the Dart and JavaScript APIs are generated from the same source,
7-
you might find the JavaScript API docs helpful:
7+
[ngio-issues]: https://github.com/angular/angular.io/issues
8+
[api-issues]: https://github.com/angular/angular.io/labels/api
89

9-
p.text-center
10-
<b><a href="/docs/js/latest/api/">Angular 2 API Preview (JavaScript)</a></b>
10+
api-list(src="api-list.json")

0 commit comments

Comments
 (0)