Skip to content
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

docs: show additional interfaces #8376

Merged
merged 2 commits into from
Nov 20, 2017

Conversation

devversion
Copy link
Member

  • Shows additional interfaces in the Dgeni API documentation
  • Adds documentation for the RippleGlobalOptions

Closes #8298.

@devversion devversion added docs This issue is related to documentation pr: needs review labels Nov 11, 2017
@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Nov 11, 2017
@devversion devversion force-pushed the docs/show-additional-interfaces branch 2 times, most recently from cc88010 to 521ffd4 Compare November 11, 2017 12:02
Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

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

Do we need to audit other interfaces for having proper docs before publishing once we merge this?

import {PropertyMemberDoc} from 'dgeni-packages/typescript/api-doc-types/PropertyMemberDoc';
import {NormalizedMethodMemberDoc} from './normalize-method-parameters';

export interface CategorizedClassLikeDoc extends ClassLikeExportDoc {
Copy link
Member

Choose a reason for hiding this comment

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

Add descriptions for these?

Copy link
Member Author

Choose a reason for hiding this comment

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

Those are just simple modifications to the real Dgeni documents - added comments to all of the modified definitions in this file.

@devversion devversion force-pushed the docs/show-additional-interfaces branch from 521ffd4 to a5ccacb Compare November 14, 2017 18:16
Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

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

LGTM

@jelbourn jelbourn added pr: lgtm action: merge The PR is ready for merge by the caretaker and removed pr: needs review labels Nov 14, 2017
* Shows additional interfaces in the Dgeni API documentation
* Adds documentation for the `RippleGlobalOptions`

Closes angular#8298.
@devversion devversion force-pushed the docs/show-additional-interfaces branch from a5ccacb to 4b5f835 Compare November 19, 2017 09:09
@jelbourn jelbourn merged commit 3b41005 into angular:master Nov 20, 2017
@devversion devversion deleted the docs/show-additional-interfaces branch November 20, 2017 19:26
@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 7, 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 docs This issue is related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Global Disable Ripple Does Not Affect Keyboard Focus
3 participants