add comments

Author: annieyw

src/material/tree/testing/node-harness.ts

@@ -14,31 +14,43 @@ import {
 import {TreeNodeHarnessFilters} from './tree-harness-filters';
 import {coerceBooleanProperty, coerceNumberProperty} from '@angular/cdk/coercion';
 
+/** Harness for interacting with a standard Angular Material tree node. */
 export class MatTreeNodeHarness extends ComponentHarness {
+  /** The selector of the host element of a `MatTreeNode` instance. */
   static hostSelector = '.mat-tree-node';
 
    _toggle = this.locatorForOptional('mattreenodetoggle');
 
+  /**
+   * Gets a `HarnessPredicate` that can be used to search for a tree node with specific attributes.
+   * @param options Options for narrowing the search
+   * @return a `HarnessPredicate` configured with the given options.
+   */
   static with(options: TreeNodeHarnessFilters = {}): HarnessPredicate<MatTreeNodeHarness> {
     return getNodePredicate(MatTreeNodeHarness, options);
   }
 
+  /** Whether the tree node is expanded. */
   async isExpanded(): Promise<boolean> {
     return coerceBooleanProperty(await (await this.host()).getAttribute('aria-expanded'));
   }
 
+  /** Whether the tree node is disabled. */
   async isDisabled(): Promise<boolean> {
     return coerceBooleanProperty(await (await this.host()).getProperty('aria-disabled'));
   }
 
+  /** Gets the level of the tree node.. */
   async getLevel(): Promise<number> {
     return coerceNumberProperty(await (await this.host()).getAttribute('aria-level'));
   }
 
+  /** Gets the role of the tree node. 'group' or 'treeitem' */
   async getRole(): Promise<string|null> {
     return (await this.host()).getAttribute('role');
   }
 
+  /** Gets the tree node's text. */
   async getText(): Promise<string> {
     return (await this.host()).text();
   }
@@ -51,9 +63,17 @@ export class MatTreeNodeHarness extends ComponentHarness {
   }
 }
 
+/** Harness for interacting with a standard Angular Material nested tree node. */
 export class MatNestedTreeNodeHarness extends MatTreeNodeHarness {
+  /** The selector for the host element of a `MatNestedTreeNode` instance. */
   static hostSelector = '.mat-nested-tree-node';
 
+  /**
+   * Gets a `HarnessPredicate` that can be used to search for
+   * a nested tree node with specific attributes.
+   * @param options Options for narrowing the search
+   * @return a `HarnessPredicate` configured with the given options.
+   */
   static with(options: TreeNodeHarnessFilters = {}): HarnessPredicate<MatNestedTreeNodeHarness> {
     return getNodePredicate(MatNestedTreeNodeHarness, options);
   }

src/material/tree/testing/shared.spec.ts

@@ -6,7 +6,7 @@ import {
   MatTreeModule,
   MatTreeNestedDataSource
 } from '@angular/material/tree';
-import {MatTreeHarness} from '@angular/material/tree/testing/tree-harness';
+import {MatTreeHarness} from '@angular/material/tree/testing';
 import {ComponentFixture, TestBed} from '@angular/core/testing';
 import {HarnessLoader} from '@angular/cdk/testing';
 import {TestbedHarnessEnvironment} from '@angular/cdk/testing/testbed';

src/material/tree/testing/tree-harness-filters.ts

@@ -8,18 +8,24 @@
 
 import {BaseHarnessFilters} from '@angular/cdk/testing';
 
+/** A set of criteria that can be used to filter a list of tree harness instances */
 export interface TreeHarnessFilters extends BaseHarnessFilters {
 }
 
+/** A set of criteria that can be used to filter a list of node harness instances. */
 export interface TreeNodeHarnessFilters extends BaseHarnessFilters {
   /** Only find instances whose text matches the given value. */
   text?: string | RegExp;
+
   /** Only find instances whose state matches the given value. */
   disabled?: boolean;
+
   /** Only find instances whose expansion state matches the given value. */
   expanded?: boolean;
+
   /** Only find instances whose role matches the given value. */
   role?: 'treeitem'|'group';
+
   /** Only find instances whose level matches the given value. */
   level?: number;
 }

src/material/tree/testing/tree-harness.ts

@@ -8,14 +8,13 @@
 
 import {ComponentHarness, HarnessPredicate} from '@angular/cdk/testing';
 import {
+  MatNestedTreeNodeHarness,
+  MatTreeNodeHarness,
   TreeHarnessFilters,
   TreeNodeHarnessFilters
-} from '@angular/material/tree/testing/tree-harness-filters';
-import {
-  MatNestedTreeNodeHarness,
-  MatTreeNodeHarness
-} from '@angular/material/tree/testing/node-harness';
+} from '@angular/material/tree/testing';
 
+/** Harness for interacting with a standard mat-tree in tests. */
 export class MatTreeHarness extends ComponentHarness {
   /** The selector for the host element of a `MatTableHarness` instance. */
   static hostSelector = '.mat-tree';
@@ -29,10 +28,12 @@ export class MatTreeHarness extends ComponentHarness {
     return new HarnessPredicate(MatTreeHarness, options);
   }
 
+  /** Gets all of the nodes in the tree. */
   async getNodes(filter: TreeNodeHarnessFilters = {}): Promise<MatTreeNodeHarness[]> {
     return this.locatorForAll(MatTreeNodeHarness.with(filter))();
   }
 
+  /** Gets all of the nested nodes in the tree. */
   async getNestedNodes(filter: TreeNodeHarnessFilters = {}): Promise<MatNestedTreeNodeHarness[]> {
     return this.locatorForAll(MatNestedTreeNodeHarness.with(filter))();
   }