-
Notifications
You must be signed in to change notification settings - Fork 6.8k
docs: add jsdoc annotations everywhere #2321
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.
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
Conversation
Adds JSDoc annotations to all of the public properties and methods that were missing them. Also cleans up some random issues that were noticed while going through everything.
@@ -98,10 +98,12 @@ export class MdButtonToggleGroup implements AfterViewInit, ControlValueAccessor | |||
@ContentChildren(forwardRef(() => MdButtonToggle)) | |||
_buttonToggles: QueryList<MdButtonToggle> = null; | |||
|
|||
/** @docs-private */ | |||
ngAfterViewInit() { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All the lifecycle hooks should be already filtered in this processor
* Gets whether an element is disabled. | ||
* | ||
* @param element Element to be checked. | ||
* @returns {boolean} Whether the element is disabled. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't need the type here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We do, dgeni doesn't figure out the return types, it was requested by @jelbourn.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is that? Can't we extend Dgeni to understand that?
EDIT: It seems like it already has the functionality: here
@@ -9,16 +9,22 @@ import { | |||
AfterContentInit | |||
} from '@angular/core'; | |||
|
|||
/** | |||
* Directive that triggers a callback whenever the content of | |||
* it's associated element has changed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be its
?
LGTM; I'll make any tweaks after merging |
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Adds JSDoc annotations to all of the public properties and methods that were missing them. Also cleans up some random issues that were noticed while going through everything.
Note: I've skipped the toolbar component since @devversion mentioned that he's doing it already.