Skip to content

docs(input): cleanup property comments for generated docs #4751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 23, 2017
Merged

docs(input): cleanup property comments for generated docs #4751

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
847cafd
Convert comments to jsdoc for MdHint
willshowell May 23, 2017
75da7d4
Add jsdoc comment for mdInput.empty
willshowell May 23, 2017
d4b1174
Add underlineRef jsdoc comment and change grammar of hideRequiredMarker
willshowell May 23, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/lib/input/input-container.ts
View file
Open in desktop
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