From 4851dea42eefc9b2ae954863922cf12a1ac48cbb Mon Sep 17 00:00:00 2001 From: Austin Date: Mon, 7 Aug 2017 12:23:47 -0500 Subject: [PATCH] chore(build): add examples to docs build and annotate table examples (#6311) --- src/material-examples/example-module.ts | 14 +++++++------- .../table-basic/table-basic-example.ts | 3 +++ .../table-http/table-http-example.ts | 3 +++ tools/gulp/tasks/docs.ts | 1 + 4 files changed, 14 insertions(+), 7 deletions(-) diff --git a/src/material-examples/example-module.ts b/src/material-examples/example-module.ts index 7bed331a4280..740dd1402234 100644 --- a/src/material-examples/example-module.ts +++ b/src/material-examples/example-module.ts @@ -73,8 +73,8 @@ import {PizzaPartyComponent,SnackBarComponentExample} from './snack-bar-componen import {SnackBarOverviewExample} from './snack-bar-overview/snack-bar-overview-example'; import {SortOverviewExample} from './sort-overview/sort-overview-example'; import {TableBasicExample} from './table-basic/table-basic-example'; -import {TableHttpExample} from './table-http/table-http-example'; import {TableFilteringExample} from './table-filtering/table-filtering-example'; +import {TableHttpExample} from './table-http/table-http-example'; import {TableOverviewExample} from './table-overview/table-overview-example'; import {TablePaginationExample} from './table-pagination/table-pagination-example'; import {TableSortingExample} from './table-sorting/table-sorting-example'; @@ -446,18 +446,18 @@ export const EXAMPLE_COMPONENTS = { additionalFiles: null, selectorName: null }, - 'table-http': { - title: 'Table retrieving data through HTTP', - component: TableHttpExample, - additionalFiles: null, - selectorName: null - }, 'table-filtering': { title: 'Table with filtering', component: TableFilteringExample, additionalFiles: null, selectorName: null }, + 'table-http': { + title: 'Table retrieving data through HTTP', + component: TableHttpExample, + additionalFiles: null, + selectorName: null + }, 'table-overview': { title: 'Feature-rich data table', component: TableOverviewExample, diff --git a/src/material-examples/table-basic/table-basic-example.ts b/src/material-examples/table-basic/table-basic-example.ts index be57119ec16e..f5ca4a861077 100644 --- a/src/material-examples/table-basic/table-basic-example.ts +++ b/src/material-examples/table-basic/table-basic-example.ts @@ -3,6 +3,9 @@ import {DataSource} from '@angular/cdk/table'; import {Observable} from 'rxjs/Observable'; import 'rxjs/add/observable/of'; +/** + * @title Basic table + */ @Component({ selector: 'table-basic-example', styleUrls: ['table-basic-example.css'], diff --git a/src/material-examples/table-http/table-http-example.ts b/src/material-examples/table-http/table-http-example.ts index 62a555bf34bc..1c24f2b1263e 100644 --- a/src/material-examples/table-http/table-http-example.ts +++ b/src/material-examples/table-http/table-http-example.ts @@ -10,6 +10,9 @@ import 'rxjs/add/operator/map'; import 'rxjs/add/operator/startWith'; import 'rxjs/add/operator/switchMap'; +/** + * @title Table retrieving data through HTTP + */ @Component({ selector: 'table-http-example', styleUrls: ['table-http-example.css'], diff --git a/tools/gulp/tasks/docs.ts b/tools/gulp/tasks/docs.ts index 5360b72cc27e..8a8ac44a2b10 100644 --- a/tools/gulp/tasks/docs.ts +++ b/tools/gulp/tasks/docs.ts @@ -64,6 +64,7 @@ task('docs', [ 'highlight-examples', 'api-docs', 'minified-api-docs', + 'build-examples-module', 'plunker-example-assets', ]);