Skip to content

Commit fa0e914

Browse files
willshowelltinayuangao
authored andcommitted
docs(input): cleanup property comments for generated docs (#4751)
* Convert comments to jsdoc for MdHint * Add jsdoc comment for mdInput.empty * Add underlineRef jsdoc comment and change grammar of hideRequiredMarker
1 parent 65d9187 commit fa0e914

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/lib/input/input-container.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,10 +70,10 @@ export class MdPlaceholder {}
7070
}
7171
})
7272
export class MdHint {
73-
// Whether to align the hint label at the start or end of the line.
73+
/** Whether to align the hint label at the start or end of the line. */
7474
@Input() align: 'start' | 'end' = 'start';
7575

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

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

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

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

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

341343
@ContentChild(MdInputDirective) _mdInputChild: MdInputDirective;

0 commit comments

Comments
 (0)