docs(table): add missing table Jsdoc

Author: jelbourn

guides/cdk-table.md

@@ -6,8 +6,9 @@ The table provides a foundation upon which other features, such as sorting and p
 built. Because it enforces no opinions on these matters, developers have full control over the
 interaction patterns associated with the table.
 
-For a Material Design styled table, see the documentation for `<md-table>` which builds on top of
-the CDK data-table.
+For a Material Design styled table, see the
+[documentation for `<md-table>`](https://material.angular.io/components/table) which builds on
+top of the CDK data-table.
 
 <!-- example(cdk-table-basic) -->
 
@@ -117,12 +118,9 @@ sorting and pagination.
 
 ##### `trackBy`
 To improve performance, a trackBy function can be provided to the table similar to Angular’s
-(`ngFor` trackBy)[trackBy]. This informs the table how to uniquely identify rows to track how the
-data changes with each update.
+[`ngFor` trackBy](https://angular.io/api/common/NgForOf#change-propagation). This informs the
+table how to uniquely identify rows to track how the data changes with each update.
 
 ```html
 <cdk-table [dataSource]="dataSource" [trackBy]="myTrackById">
 ```
-
-
-[trackBy][https://angular.io/api/common/NgForOf#change-propagation]

package.json

@@ -34,6 +34,7 @@
     "@angular/http": "~4.1.0",
     "@angular/platform-browser": "~4.1.0",
     "core-js": "^2.4.1",
+    "material2-build-tools": "file:tools/package-tools",
     "rxjs": "^5.0.1",
     "systemjs": "0.19.43",
     "tslib": "^1.7.1",

src/cdk/table/cell.ts

@@ -32,9 +32,13 @@ export class CdkHeaderCellDef {
  */
 @Directive({selector: '[cdkColumnDef]'})
 export class CdkColumnDef {
+  /** Unique name for this column. */
   @Input('cdkColumnDef') name: string;
 
+  /** @docs-private */
   @ContentChild(CdkCellDef) cell: CdkCellDef;
+
+  /** @docs-private */
   @ContentChild(CdkHeaderCellDef) headerCell: CdkHeaderCellDef;
 }
 

src/cdk/table/data-source.ts

@@ -13,6 +13,20 @@ export interface CollectionViewer {
 }
 
 export abstract class DataSource<T> {
+  /**
+   * Connects a collection viewer (such as a data-table) to this data source.
+   * @param collectionViewer The component that exposes a view over the data provided by this
+   *     data source.
+   * @returns Observable that emits a new value when the data changes.
+   */
   abstract connect(collectionViewer: CollectionViewer): Observable<T[]>;
+
+  /**
+   * Disconnects a collection viewer (such as a data-table) from this data source. Can be used
+   * to perform any clean-up or tear-down operations when a view is being destroyed.
+   *
+   * @param collectionViewer The component that exposes a view over the data provided by this
+   *     data source.
+   */
   abstract disconnect(collectionViewer: CollectionViewer): void;
 }

src/lib/sort/sort-header-intl.ts

@@ -15,12 +15,17 @@ import {SortDirection} from './sort-direction';
  */
 @Injectable()
 export class MdSortHeaderIntl {
-  sortButtonLabel = (id: string) => {
+  /** Function that, given the column ID, returns the label for the sort header. */
+  sortButtonLabel: (string) => string = (id: string) => {
     return `Change sorting for ${id}`;
-  }
+  };
 
-  /** A label to describe the current sort (visible only to screenreaders). */
-  sortDescriptionLabel = (id: string, direction: SortDirection) => {
-    return `Sorted by ${id} ${direction == 'asc' ? 'ascending' : 'descending'}`;
-  }
+  /**
+   * Function that, given the column ID and sort direction, returns the label for the active sort
+   * state.
+   */
+  sortDescriptionLabel: (string, SortDirection) => string =
+      (id: string, direction: SortDirection) => {
+        return `Sorted by ${id} ${direction == 'asc' ? 'ascending' : 'descending'}`;
+      };
 }

src/lib/sort/sort-header.ts

@@ -39,6 +39,7 @@ import {Subscription} from 'rxjs/Subscription';
   changeDetection: ChangeDetectionStrategy.OnPush,
 })
 export class MdSortHeader implements MdSortable {
+  /** @docs-private  */
   sortSubscription: Subscription;
 
   /**

src/lib/table/table.md

@@ -10,7 +10,8 @@ instead of `cdk-`.
 Note that the column definition directives (`cdkColumnDef` and `cdkHeaderCellDef`) are still
 prefixed with `cdk-`.
 
-For more information on the interface and how it works, see the guide covering the CDK data-table.
+For more information on the interface and how it works, see the
+[guide covering the CDK data-table](https://material.angular.io/guides/cdk-table).
 
 ### Features
 
@@ -46,4 +47,4 @@ an update via the table's data source.
 
 In the near future, we will provide a simplified version of the data-table with an easy-to-use
 interface, material styling, array input, and more out-of-the-box features (sorting, pagination,
-and selection).
+and selection).

src/material-examples/input-clearable/input-clearable-example.html

@@ -1,6 +1,6 @@
 <md-input-container class="example-input-container">
   <input mdInput type="text" placeholder="Clearable input" [(ngModel)]="value"/>
-  <md-button *ngIf="value" mdSuffix md-icon-button aria-label="Clear" (click)="value=''">
+  <button md-button *ngIf="value" mdSuffix md-icon-button aria-label="Clear" (click)="value=''">
     <md-icon>close</md-icon>
-  </md-button>
+  </button>
 </md-input-container>

src/material-examples/table-basic/table-basic-example.css

@@ -3,7 +3,6 @@
   display: flex;
   flex-direction: column;
   max-height: 500px;
-  background: white;
   min-width: 300px;
 }
 

src/material-examples/table-basic/table-basic-example.html

@@ -1,6 +1,4 @@
 <div class="example-container mat-elevation-z8">
-  <div class="example-header"> Users </div>
-
   <md-table #table [dataSource]="dataSource">
 
     <!--- Note that these columns can be defined in any order.
@@ -33,4 +31,4 @@
     <md-header-row *cdkHeaderRowDef="displayedColumns"></md-header-row>
     <md-row *cdkRowDef="let row; columns: displayedColumns;"></md-row>
   </md-table>
-</div>
+</div>

src/material-examples/table-filtering/table-filtering-example.css

@@ -3,7 +3,6 @@
   display: flex;
   flex-direction: column;
   max-height: 500px;
-  background: white;
   min-width: 300px;
 }
 

src/material-examples/table-filtering/table-filtering-example.html

@@ -1,7 +1,5 @@
 <div class="example-container mat-elevation-z8">
   <div class="example-header">
-    Users
-
     <md-input-container floatPlaceholder="never">
       <input mdInput #filter placeholder="Filter users">
     </md-input-container>
@@ -39,4 +37,4 @@
     <md-header-row *cdkHeaderRowDef="displayedColumns"></md-header-row>
     <md-row *cdkRowDef="let row; columns: displayedColumns;"></md-row>
   </md-table>
-</div>
+</div>

src/material-examples/table-overview/table-overview-example.css

@@ -3,7 +3,6 @@
   display: flex;
   flex-direction: column;
   max-height: 500px;
-  background: white;
   min-width: 300px;
 }
 

src/material-examples/table-overview/table-overview-example.html

@@ -1,7 +1,5 @@
 <div class="example-container mat-elevation-z8">
   <div class="example-header" [style.display]="selection.isEmpty() ? '' : 'none'">
-    Users
-
     <md-input-container floatPlaceholder="never">
       <input mdInput #filter placeholder="Filter users">
     </md-input-container>

src/material-examples/table-pagination/table-pagination-example.css

@@ -3,7 +3,6 @@
   display: flex;
   flex-direction: column;
   max-height: 500px;
-  background: white;
   min-width: 300px;
 }
 

src/material-examples/table-pagination/table-pagination-example.html

@@ -1,5 +1,4 @@
 <div class="example-container mat-elevation-z8">
-  <div class="example-header"> Users </div>
 
   <md-table #table [dataSource]="dataSource">
 
@@ -40,4 +39,4 @@
                 [pageSize]="25"
                 [pageSizeOptions]="[5, 10, 25, 100]">
   </md-paginator>
-</div>
+</div>

src/material-examples/table-sorting/table-sorting-example.css

@@ -3,7 +3,6 @@
   display: flex;
   flex-direction: column;
   max-height: 500px;
-  background: white;
   min-width: 300px;
 }
 
@@ -21,4 +20,4 @@
 
 .mat-header-cell .mat-sort-header-sorted {
   color: black;
-}
+}

src/material-examples/table-sorting/table-sorting-example.html

@@ -1,6 +1,4 @@
 <div class="example-container mat-elevation-z8">
-  <div class="example-header"> Users </div>
-
   <md-table #table [dataSource]="dataSource" mdSort>
 
     <!--- Note that these columns can be defined in any order.
@@ -33,4 +31,4 @@
     <md-header-row *cdkHeaderRowDef="displayedColumns"></md-header-row>
     <md-row *cdkRowDef="let row; columns: displayedColumns;"></md-row>
   </md-table>
-</div>
+</div>

tools/dgeni/index.js

@@ -115,6 +115,8 @@ let apiDocsPackage = new DgeniPackage('material2-api-docs', dgeniPackageDeps)
     'lib/slide-toggle/index.ts',
     'lib/slider/index.ts',
     'lib/snack-bar/index.ts',
+    'lib/sort/index.ts',
+    'lib/table/index.ts',
     'lib/tabs/index.ts',
     'lib/toolbar/index.ts',
     'lib/tooltip/index.ts',