Skip to content

Fixing some javadoc errors so Doc Linters would shut up - #9

Merged
hiranya911 merged 2 commits into
masterfrom
hkj-javadoc-updates
Apr 19, 2017
Merged

Fixing some javadoc errors so Doc Linters would shut up#9
hiranya911 merged 2 commits into
masterfrom
hkj-javadoc-updates

Conversation

@hiranya911

Copy link
Copy Markdown
Contributor

Starting from Java 8, the javadoc generators are very strict about malformed javadoc comments. Fixing some of the errors encountered.

* @param cancelError If a cancelError is provided, appropriate cancel events will be returned.
* @return {{removed:!Array.<!fb.api.Query>, events:!Array.<!fb.core.view.Event>}} removed queries
* and any cancel events
* @return a Pair of lists consisting of removed queries and any cancel events.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Just FYI- We should not be including anything under core/ (or any other subpackage) when generating javadoc. :)

@hiranya911
hiranya911 merged commit dccc693 into master Apr 19, 2017
@hiranya911
hiranya911 deleted the hkj-javadoc-updates branch April 19, 2017 21:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants