docs: new docs for timepicker #708
Conversation
| @@ -21,44 +21,64 @@ import { PopperOptions } from 'popper.js'; | |||
| styles: [':host {display: inline-block;}'] | |||
| }) | |||
| export class TimePickerComponent implements ControlValueAccessor, OnInit { | |||
|
|
|||
| /** @Input An object that contains three integer properties: 'hour' (ranging from 0 to 23), | |||
| * 'minute' (ranging from 0 to 59), and 'second' (ranging from 0 to 59). */ | |||
| @Input() | |||
| time: TimeObject = { hour: 0, minute: 0, second: 0 }; | |||
There was a problem hiding this comment.
As mentioned in the other PR, consider using markdown to make this look a bit nicer, maybe a list or something?
also maybe explain what it is used for on top of what it consists of
| @Input() | ||
| time: TimeObject = { hour: 0, minute: 0, second: 0 }; | ||
|
|
||
| /** @Input Uses compact time picker. */ |
There was a problem hiding this comment.
Whether the time picker should be in compact mode. maybe?
Uses compact time picker isnt very clear
| @Input() | ||
| compact: boolean = false; | ||
|
|
||
| /** @Input Boolean, when set to true, uses the 24 hour clock (hours ranging from 0 to 23) | ||
| * and does not display a period control. Default is false. */ | ||
| @Input() | ||
| meridian: boolean; |
There was a problem hiding this comment.
remove 'Boolean,' and also 'Default is false', consider adding boolean = false to the input
| @Input() | ||
| disabled: boolean; | ||
|
|
||
| /** @Input Boolean, when set to false, hides the buttons that increment and decrement the corresponding input. Default is true. */ | ||
| @Input() | ||
| spinners: boolean = true; |
There was a problem hiding this comment.
remove 'Boolean,' and 'Default is..'
| @Input() | ||
| spinners: boolean = true; | ||
|
|
||
| /** @Input Boolean, when set to false, hides the input for seconds. Default is true. */ | ||
| @Input() | ||
| displaySeconds: boolean = true; |
There was a problem hiding this comment.
remove 'Boolean,' and 'Default is..'
| ngOnInit(): void { | ||
| this.placeholder = this.getPlaceholder(); | ||
| } | ||
|
|
||
| /** | ||
| * @returns Returns the current value of the time input. | ||
| */ | ||
| getTime() { |
There was a problem hiding this comment.
If this returns something, the return type should be explicitly given by the function.
In that case, you would not need the @returns, typedoc will infer the return type. You'd just need a small explanation of what the method does.
| @@ -108,6 +128,7 @@ export class TimePickerComponent implements ControlValueAccessor, OnInit { | |||
| return formattedTime !== undefined ? formattedTime : ''; | |||
There was a problem hiding this comment.
should also identify the return type in the method head (not part of the docs issue tho)
| @@ -215,29 +241,35 @@ export class TimePickerComponent implements ControlValueAccessor, OnInit { | |||
| return retVal; | |||
fixes #690