Skip to content

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

Merged
merged 5 commits into from
Dec 21, 2016

Conversation

crisbeto
Copy link
Member

@crisbeto crisbeto commented Dec 21, 2016

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.

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.
@crisbeto crisbeto requested a review from jelbourn December 21, 2016 12:22
@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Dec 21, 2016
@@ -98,10 +98,12 @@ export class MdButtonToggleGroup implements AfterViewInit, ControlValueAccessor
@ContentChildren(forwardRef(() => MdButtonToggle))
_buttonToggles: QueryList<MdButtonToggle> = null;

/** @docs-private */
ngAfterViewInit() {
Copy link
Member

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.
Copy link
Member

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

Copy link
Member Author

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.

Copy link
Member

@devversion devversion Dec 21, 2016

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be its?

@jelbourn
Copy link
Member

LGTM; I'll make any tweaks after merging

@jelbourn jelbourn added pr: lgtm action: merge The PR is ready for merge by the caretaker and removed pr: needs review labels Dec 21, 2016
@jelbourn jelbourn merged commit e372596 into angular:master Dec 21, 2016
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 6, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants