[JAVA-620] Javadocs should include code samples, and links to docs/manual Created: 14/Aug/12 Updated: 23/Jun/15 Resolved: 23/Jun/15 |
|
| Status: | Closed |
| Project: | Java Driver |
| Component/s: | Documentation |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Improvement | Priority: | Minor - P4 |
| Reporter: | William Zola | Assignee: | Unassigned |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||
| Description |
|
The javadocs should include sample code for commonly used methods. The javadocs should link to the docs/manual to the conceptual pages like all findAndModify/Remove methods should link to the "findAndModify" docs page. |
| Comments |
| Comment by Jeffrey Yemin [ 23/Jun/15 ] |
|
The 3.0 Javadocs contain number links to the manual, and the new reference documentation has numerous code samples. |