<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Thu Feb 08 08:58:45 UTC 2024

It is possible to restrict the fields that are returned in this document by specifying the 'field' parameter in your request.
For example, to request only the issue key and summary append 'field=key&field=summary' to the URL of your request.
-->
<rss version="0.92" >
<channel>
    <title>MongoDB Jira</title>
    <link>https://jira.mongodb.org</link>
    <description>This file is an XML representation of an issue</description>
    <language>en-us</language>    <build-info>
        <version>9.7.1</version>
        <build-number>970001</build-number>
        <build-date>13-04-2023</build-date>
    </build-info>


<item>
            <title>[JAVA-3091] Produce separate Javadoc trees for the different drivers</title>
                <link>https://jira.mongodb.org/browse/JAVA-3091</link>
                <project id="10006" key="JAVA">Java Driver</project>
                    <description>&lt;p&gt;When using the Java driver, you need to decide which one of the 3 different ones you will use. Then you select the one you want from the drop down menu at:&lt;br/&gt;
&#160; &lt;a href=&quot;https://mongodb.github.io/mongo-java-driver/&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://mongodb.github.io/mongo-java-driver/&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;After installing the driver, if you need information about the classes and search for a given class in the Java docs at:&lt;/p&gt;

&lt;p&gt;&#160; &lt;a href=&quot;http://mongodb.github.io/mongo-java-driver&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;http://mongodb.github.io/mongo-java-driver&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;You see only one set of docs for the 3 products.&lt;br/&gt;
Taking a &quot;MongoClient&quot; object for example; in one driver it is an interface and a class in another. The listed methods are not available in all drivers, so it is confusing if you use the Javadocs to see what you can do on an object&lt;/p&gt;

&lt;p&gt;I think we should have 3 sets of Javadocs, one per downloadable driver.&lt;br/&gt;
It could be something like the following:&lt;/p&gt;



&lt;p&gt;*&#160;&lt;a href=&quot;http://mongodb.github.io/mongo-java-driver&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;http://mongodb.github.io/mongo-java-driver&lt;/a&gt;/mongodb-driver-sync/&amp;lt;versions&amp;gt;&lt;br/&gt;
*&#160;&lt;a href=&quot;http://mongodb.github.io/mongo-java-driver&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;http://mongodb.github.io/mongo-java-driver/mongodb-driver-async/&amp;lt;versions&amp;gt;&lt;/a&gt;&lt;br/&gt;
*&#160;&lt;a href=&quot;http://mongodb.github.io/mongo-java-driver&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;http://mongodb.github.io/mongo-java-driver&lt;/a&gt;/mongodb-driver-legacy/&amp;lt;versions&amp;gt;&lt;/p&gt;



&lt;p&gt;As a user, I would see the docs that match the product I am using.&lt;/p&gt;

&lt;p&gt;&#160;&lt;/p&gt;</description>
                <environment></environment>
        <key id="633509">JAVA-3091</key>
            <summary>Produce separate Javadoc trees for the different drivers</summary>
                <type id="4" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14710&amp;avatarType=issuetype">Improvement</type>
                                            <priority id="3" iconUrl="https://jira.mongodb.org/images/icons/priorities/major.svg">Major - P3</priority>
                        <status id="6" iconUrl="https://jira.mongodb.org/images/icons/statuses/closed.png" description="The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.">Closed</status>
                    <statusCategory id="3" key="done" colorName="success"/>
                                    <resolution id="13201">Fixed</resolution>
                                        <assignee username="ross@mongodb.com">Ross Lawley</assignee>
                                    <reporter username="daniel.coupal@mongodb.com">Daniel Coupal</reporter>
                        <labels>
                    </labels>
                <created>Wed, 14 Nov 2018 00:02:49 +0000</created>
                <updated>Sat, 28 Oct 2023 11:22:31 +0000</updated>
                            <resolved>Mon, 3 Feb 2020 13:45:47 +0000</resolved>
                                                    <fixVersion>4.0.0</fixVersion>
                                    <component>Build</component>
                    <component>Documentation</component>
                                        <votes>0</votes>
                                    <watches>3</watches>
                                                                                                                <comments>
                            <comment id="2780004" author="xgen-internal-githook" created="Mon, 3 Feb 2020 13:44:20 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{&apos;username&apos;: &apos;rozza&apos;, &apos;name&apos;: &apos;Ross Lawley&apos;, &apos;email&apos;: &apos;ross.lawley@gmail.com&apos;}
&lt;p&gt;Message: Java/ScalaDoc: Now publishing separate docs per project.&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://jira.mongodb.org/browse/JAVA-3091&quot; title=&quot;Produce separate Javadoc trees for the different drivers&quot; class=&quot;issue-link&quot; data-issue-key=&quot;JAVA-3091&quot;&gt;&lt;del&gt;JAVA-3091&lt;/del&gt;&lt;/a&gt;&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/mongo-java-driver/commit/d6e3fa55da83ccc24e83e3db50eaaa49887b1250&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-java-driver/commit/d6e3fa55da83ccc24e83e3db50eaaa49887b1250&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="2770374" author="ross@10gen.com" created="Wed, 29 Jan 2020 15:11:39 +0000"  >&lt;p&gt;PR: &lt;a href=&quot;https://github.com/rozza/mongo-java-driver/pull/358&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/rozza/mongo-java-driver/pull/358&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="2062334" author="daniel.coupal" created="Wed, 14 Nov 2018 21:00:16 +0000"  >&lt;p&gt;Thanks &lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=ross.lawley&quot; class=&quot;user-hover&quot; rel=&quot;ross.lawley&quot;&gt;ross.lawley&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;We may change our course to use 3.9.0.&lt;/p&gt;

&lt;p&gt;It would make it easier for the student if they have a matching documentation.&lt;/p&gt;</comment>
                            <comment id="2061223" author="ross@10gen.com" created="Wed, 14 Nov 2018 09:22:41 +0000"  >&lt;p&gt;Please note as each jar is published with its own javadoc and source jar, so you can use javadoc.io while waiting for this ticket to be fixed :&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;&lt;a href=&quot;https://www.javadoc.io/doc/org.mongodb/mongodb-driver-sync/3.9.0&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://www.javadoc.io/doc/org.mongodb/mongodb-driver-sync/3.9.0&lt;/a&gt;&lt;/li&gt;
	&lt;li&gt;&lt;a href=&quot;https://www.javadoc.io/doc/org.mongodb/mongodb-driver-async/3.9.0&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://www.javadoc.io/doc/org.mongodb/mongodb-driver-async/3.9.0&lt;/a&gt;&lt;/li&gt;
	&lt;li&gt;&lt;a href=&quot;https://www.javadoc.io/doc/org.mongodb/mongodb-driver-legacy/3.9.0&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://www.javadoc.io/doc/org.mongodb/mongodb-driver-legacy/3.9.0&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;
</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10011">
                    <name>Depends</name>
                                            <outwardlinks description="depends on">
                                        <issuelink>
            <issuekey id="190841">JAVA-1711</issuekey>
        </issuelink>
                            </outwardlinks>
                                                        </issuelinktype>
                    </issuelinks>
                <attachments>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_15850" key="com.atlassian.jira.plugins.jira-development-integration-plugin:devsummary">
                        <customfieldname>Development</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_12550" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>2|hu2h67:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10558" key="com.pyxis.greenhopper.jira:gh-global-rank">
                        <customfieldname>Rank (Obsolete)</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>9223372036854775807</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            </customfields>
    </item>
</channel>
</rss>