Skip to content

Commit

Permalink
docs(input): cleanup property comments for generated docs (#4751)
Browse files Browse the repository at this point in the history
* Convert comments to jsdoc for MdHint

* Add jsdoc comment for mdInput.empty

* Add underlineRef jsdoc comment and change grammar of hideRequiredMarker
  • Loading branch information
willshowell authored and tinayuangao committed May 23, 2017
1 parent 65d9187 commit fa0e914
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions src/lib/input/input-container.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,10 @@ export class MdPlaceholder {}
}
})
export class MdHint {
// Whether to align the hint label at the start or end of the line.
/** Whether to align the hint label at the start or end of the line. */
@Input() align: 'start' | 'end' = 'start';

// Unique ID for the hint. Used for the aria-describedby on the input.
/** Unique ID for the hint. Used for the aria-describedby on the input. */
@Input() id: string = `md-input-hint-${nextUniqueId++}`;
}

Expand Down Expand Up @@ -187,6 +187,7 @@ export class MdInputDirective {
*/
@Output() _placeholderChange = new EventEmitter<string>();

/** Whether the input is empty. */
get empty() {
return !this._isNeverEmpty() &&
(this.value == null || this.value === '') &&
Expand Down Expand Up @@ -299,7 +300,7 @@ export class MdInputContainer implements AfterViewInit, AfterContentInit, AfterC
get dividerColor() { return this.color; }
set dividerColor(value) { this.color = value; }

/** Whether we should hide the required marker. */
/** Whether the required marker should be hidden. */
@Input()
get hideRequiredMarker() { return this._hideRequiredMarker; }
set hideRequiredMarker(value: any) {
Expand Down Expand Up @@ -336,6 +337,7 @@ export class MdInputContainer implements AfterViewInit, AfterContentInit, AfterC
}
private _floatPlaceholder: FloatPlaceholderType = 'auto';

/** Reference to the input's underline element. */
@ViewChild('underline') underlineRef: ElementRef;

@ContentChild(MdInputDirective) _mdInputChild: MdInputDirective;
Expand Down

0 comments on commit fa0e914

Please sign in to comment.