Use Javadoc for API documentation#305
Merged
v-nisidh merged 1 commit intomicrosoft:devfrom Jun 8, 2017
marschall:javadoc-for-api-documentation
Merged
Use Javadoc for API documentation#305v-nisidh merged 1 commit intomicrosoft:devfrom marschall:javadoc-for-api-documentation
v-nisidh merged 1 commit intomicrosoft:devfrom
marschall:javadoc-for-api-documentation
Conversation
Java offers two kinds of multi line comments /** and /*. The first is called Javadoc and ends up in generated API documentation and is displayed by IDEs. The second is a multi line comment that does not show up. There are several places there /* instead of /** is used for API documentation. [1] https://stackoverflow.com/questions/29815636/and-in-java-comments [2] http://javadude.com/articles/comments.html
Codecov Report
@@ Coverage Diff @@
## dev #305 +/- ##
============================================
+ Coverage 37.23% 37.36% +0.13%
- Complexity 1663 1671 +8
============================================
Files 103 103
Lines 23673 23673
Branches 3882 3882
============================================
+ Hits 8814 8846 +32
+ Misses 13261 13232 -29
+ Partials 1598 1595 -3
Continue to review full report at Codecov.
|
|
@marschall, thanks for signing the contribution license agreement. We will now validate the agreement and then the pull request. |
Contributor
Author
|
As an example have a look at: |
v-nisidh
approved these changes
Jun 8, 2017
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Java offers two kinds of multi line comments /** and /*.
The first is called Javadoc and ends up in generated API documentation
and is displayed by IDEs. The second is a multi line comment that does
not show up.
There are several places there /* instead of /** is used for API
documentation.
[1] https://stackoverflow.com/questions/29815636/and-in-java-comments
[2] http://javadude.com/articles/comments.html