[JAVA-1172] Missing in Java Docs: https://github.com/mongodb/mongo-java-driver/blob/master/src/main/com/mongodb/QueryResultIterator.java Created: 18/Apr/14 Updated: 07/Apr/23 Resolved: 18/Apr/14 |
|
| Status: | Closed |
| Project: | Java Driver |
| Component/s: | Documentation |
| Affects Version/s: | 2.12.0 |
| Fix Version/s: | None |
| Type: | Bug | Priority: | Major - P3 |
| Reporter: | Christoph Bussler | Assignee: | Unassigned |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Description |
|
https://github.com/mongodb/mongo-java-driver/blob/master/src/main/com/mongodb/QueryResultIterator.java is missing from Java docs. This is worrisome; isn't Java docs generated from the source code? Maybe the generated docs should be included in mongodb/mongo-java-driver |
| Comments |
| Comment by Jeffrey Yemin [ 18/Apr/14 ] |
|
Got it. It's just not general practice to include non-public classes in Javadoc. What I'd recommend is use Maven or Gradle as a build tool, and Intellij/Eclipse will download the source jar for the driver, and it's then very easy to find it in the IDE. |
| Comment by Christoph Bussler [ 18/Apr/14 ] |
|
I erroneously casted the result of <collection>.aggregate() to a DBCursor. That created a compilation error that mentioned QueryResultIterator as not being able to cast to DBCursor. So I went looking for that. |
| Comment by Jeffrey Yemin [ 18/Apr/14 ] |
|
What was the compilation error? Can you paste it in a comment? |
| Comment by Christoph Bussler [ 18/Apr/14 ] |
|
Hi - that might be; but I had a compilation error and I only was able to find the class by searching through github. While that's possible, that's not really efficient and helpful at all. |
| Comment by Jeffrey Yemin [ 18/Apr/14 ] |
|
It's not there because it's not a public class. Only public classes are included in Javadoc. |