<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Thu Feb 08 09:00:31 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-3819] Include package-list when deploying javadoc</title>
                <link>https://jira.mongodb.org/browse/JAVA-3819</link>
                <project id="10006" key="JAVA">Java Driver</project>
                    <description>&lt;p&gt;I&apos;m trying to reference MongoDB java driver classes&apos; javadoc from my project which is done using &lt;a href=&quot;https://maven.apache.org/plugins/maven-javadoc-plugin/examples/links-configuration.html&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;maven-javadoc-plugin&lt;/a&gt;. It was working fine in v3 of the driver. Links do not show up when I upgraded to v4.&lt;/p&gt;

&lt;p&gt;Upon investigation, the issue seems to be v4 of the java driver docs do not have the &lt;tt&gt;package-list&#160;}}file. This is required by the plugin and part of the &lt;a href=&quot;#package-list].&quot; target=&quot;_blank&quot; rel=&quot;noopener&quot;&gt;javadoc specification&lt;/a&gt;&#160;Only versions 3.4-3.10 have the {{package-list&lt;/tt&gt; file (checked on&#160;&lt;a href=&quot;https://github.com/mongodb/mongo-java-driver/find/gh-pages&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-java-driver/find/gh-pages&lt;/a&gt;).&lt;/p&gt;

&lt;p&gt;I tried building the docs using &lt;tt&gt;gradle docs&lt;/tt&gt; and the file is there so I think it&apos;s just being excluded when it&apos;s deployed to Github pages.&lt;/p&gt;</description>
                <environment></environment>
        <key id="1445117">JAVA-3819</key>
            <summary>Include package-list when deploying javadoc</summary>
                <type id="4" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14710&amp;avatarType=issuetype">Improvement</type>
                                            <priority id="4" iconUrl="https://jira.mongodb.org/images/icons/priorities/minor.svg">Minor - P4</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="13202">Works as Designed</resolution>
                                        <assignee username="ross@mongodb.com">Ross Lawley</assignee>
                                    <reporter username="djgomez23@gmail.com">Daniel John Gomez</reporter>
                        <labels>
                    </labels>
                <created>Tue, 18 Aug 2020 07:56:22 +0000</created>
                <updated>Fri, 27 Oct 2023 13:20:58 +0000</updated>
                            <resolved>Mon, 7 Sep 2020 14:09:13 +0000</resolved>
                                    <version>3.11.0</version>
                                                    <component>Documentation</component>
                                        <votes>0</votes>
                                    <watches>2</watches>
                                                                                                                <comments>
                            <comment id="3384559" author="djgomez23@gmail.com" created="Thu, 10 Sep 2020 02:17:28 +0000"  >&lt;p&gt;By the way, I also tried updating our maven javadoc plugin to 3.2.0 but it didn&apos;t work.&lt;/p&gt;</comment>
                            <comment id="3384509" author="djgomez23@gmail.com" created="Thu, 10 Sep 2020 00:58:07 +0000"  >&lt;p&gt;Hi Ross,&lt;/p&gt;

&lt;p&gt;I see. This seems to be more of a JDK issue. The javadoc cli tool (to which maven-javadoc-plugin delegates to) is still expecting package-list to reference external links correctly (&lt;a href=&quot;https://docs.oracle.com/en/java/javase/11/javadoc/javadoc-command.html#GUID-3894CFD5-88D5-407F-B603-3DCC826AE6EA__GUID-E0995916-2B2E-4BB0-A3A6-753B0C03512F&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;reference&lt;/a&gt;).&#160;&lt;/p&gt;

&lt;p&gt;I found this &lt;a href=&quot;https://bugs.openjdk.java.net/browse/JDK-8211194&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;ticket&lt;/a&gt; on OpenJDK which describes the issue but is only fixed on Java 12.&lt;/p&gt;

&lt;p&gt;I wonder if it&apos;s alright on your end to copy the element-list to package-list manually as a workaround just like how Gradle handled this issue on&#160;&lt;a href=&quot;https://github.com/gradle/gradle/pull/8193&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/gradle/gradle/pull/8193&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="3377434" author="ross@10gen.com" created="Mon, 7 Sep 2020 14:09:05 +0000"  >&lt;p&gt;Hi &lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=djgomez23%40gmail.com&quot; class=&quot;user-hover&quot; rel=&quot;djgomez23@gmail.com&quot;&gt;djgomez23@gmail.com&lt;/a&gt;,&lt;/p&gt;

&lt;p&gt;The javadocs generated by versions 3.11+ use Java 11 which doesn&apos;t publish a &lt;tt&gt;package-list&lt;/tt&gt; but does publish a &lt;tt&gt;elements-list&lt;/tt&gt; file instead.  &lt;/p&gt;

&lt;p&gt;Happily the error has been reported and fixed in the maven-javadoc plugin: &lt;a href=&quot;https://issues.apache.org/jira/browse/MJAVADOC-534&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;MJAVADOC-534&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;Ross&lt;/p&gt;</comment>
                    </comments>
                    <attachments>
                            <attachment id="274348" name="Screen Shot 2020-08-18 at 3.41.06 PM.png" size="126377" author="djgomez23@gmail.com" created="Tue, 18 Aug 2020 07:58:52 +0000"/>
                    </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|hxnk1b:</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>