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
fix: Add Documentation #221
Conversation
Codecov Report
@@ Coverage Diff @@
## master #221 +/- ##
=========================================
Coverage 72.17% 72.17%
Complexity 732 732
=========================================
Files 134 134
Lines 3936 3936
Branches 201 201
=========================================
Hits 2841 2841
Misses 974 974
Partials 121 121
Continue to review full report at Codecov.
|
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.
Thank you for documenting! (Worth noting:mvn site
failed when I tried to generate javadocs, so I'm reviewing based on my best guess of what will be rendered.)
Most of this looks good. I suggested links in a few places where they will save developers' a Google search.
Unrelated to this PR but would be nice to fix some existing documentation. The code below isn't rendered correctly in the javadocs:
Lines 27 to 44 in 6aa3247
/** | |
* try-with-resources wrapper for enterWhenUninterruptibly. For example: | |
* | |
* <pre>{@code | |
* final Monitor.Guard guard = new Monitor.Guard(monitor.monitor) { | |
* @Override | |
* public boolean isSatisfied() { | |
* assertThat(monitor.monitor.isOccupied()).isTrue(); | |
* return state; | |
* } | |
* }; | |
* | |
* try (CloseableMonitor.Hold h = monitor.enterWhenUninterruptibly(guard)) { | |
* // Do stuff | |
* } | |
* // Monitor is automatically released | |
* }</pre> | |
*/ |
Remove {@code}
and use <pre></pre>
only, then replace '<', '>' and '@' with HTML codes <
, >
, and @
in the code block.
Useful refs:
<a href="#{@link}">{@link URL}</a>
{@link package.class#member label}
- "A Guide to Formatting Code Snippets in Javadoc"
google-cloud-pubsublite/src/main/java/com/google/cloud/pubsublite/AdminClientSettings.java
Outdated
Show resolved
Hide resolved
google-cloud-pubsublite/src/main/java/com/google/cloud/pubsublite/Message.java
Outdated
Show resolved
Hide resolved
google-cloud-pubsublite/src/main/java/com/google/cloud/pubsublite/ProjectNumber.java
Outdated
Show resolved
Hide resolved
google-cloud-pubsublite/src/main/java/com/google/cloud/pubsublite/PublishMetadata.java
Outdated
Show resolved
Hide resolved
...oud-pubsublite/src/main/java/com/google/cloud/pubsublite/cloudpubsub/SubscriberSettings.java
Outdated
Show resolved
Hide resolved
...oud-pubsublite/src/main/java/com/google/cloud/pubsublite/cloudpubsub/SubscriberSettings.java
Show resolved
Hide resolved
I've fixed the assorted issues preventing mvn site from running, it should now run as long as you're in a context that sets JAVA_HOME. |
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.
Awesome! LGTM.
No description provided.