From fa0e91468ebcb7f18f98c483cc350f7849d15a73 Mon Sep 17 00:00:00 2001 From: Will Howell Date: Tue, 23 May 2017 16:56:58 -0400 Subject: [PATCH] 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 --- src/lib/input/input-container.ts | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/lib/input/input-container.ts b/src/lib/input/input-container.ts index c7ffb4d47f5..45a779540ba 100644 --- a/src/lib/input/input-container.ts +++ b/src/lib/input/input-container.ts @@ -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++}`; } @@ -187,6 +187,7 @@ export class MdInputDirective { */ @Output() _placeholderChange = new EventEmitter(); + /** Whether the input is empty. */ get empty() { return !this._isNeverEmpty() && (this.value == null || this.value === '') && @@ -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) { @@ -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;