https://jira.opendaylight.org This file is an XML representation of an issue en-us 8.20.10 820010 22-06-2022 https://jira.opendaylight.org/browse/RELENG-3 releng <p>It looks like javadocs are not being generated for the controller. All pointers to the existing latest generated javadocs (<a href="https://jenkins.opendaylight.org/controller/job/controller-merge/lastSuccessfulBuild/artifact/target/apidocs/index.html" class="external-link" target="_blank" rel="nofollow noopener">https://jenkins.opendaylight.org/controller/job/controller-merge/lastSuccessfulBuild/artifact/target/apidocs/index.html</a>) are invalid. </p> <p>It would also be good to put the generated javadocs as artefacts into nexus, rather than have them in jenkins.</p> <p>Operating System: All<br/> Platform: All</p> RELENG-3

Javadocs are not being generated for controller APIs

Bug Open Done Thanh Ha (zxiiro) Jan Medved Fri, 16 Jan 2015 19:37:54 +0000 Wed, 28 Feb 2018 15:53:25 +0000 Tue, 27 Feb 2018 15:42:30 +0000 unspecified Oxygen Autorelease 0 9 <p>Generated, stored in nexus but not html form.</p> <p>this should be fixed in releng builder in odlparent.</p> <p>Just my 0,02$:</p> <ul> <li>Each release and master should have hosted folder where the javadocs + yang +<br/> other APIs are documented and can be linked to from the wiki.</li> </ul> <ul> <li>The folder structure needs to be static to keep links intact. Still the doc<br/> should be autogenerated/published by jenkins from the respective branches.</li> </ul> <ul> <li>The links should be short if possible.<br/> Example from our collab project family (already quite long, but intuitive):<br/> <a href="http://www.yoctoproject.org/docs/1.8/dev-manual/dev-manual.html" class="external-link" target="_blank" rel="nofollow noopener">http://www.yoctoproject.org/docs/1.8/dev-manual/dev-manual.html</a></li> </ul> <p>Can we implement that ? I'd volunteer to fix the wiki links once we have this up.</p> <p>I would disaggree to keep folder structure intact - I would rather prefere to have maven sites working and publish them with javadocs, rather then making folder-structure our API contract because of Jenkins links.</p> <p>Maven sites <em>are</em> configured to be available in Nexus and Jenkins, nobody is taking advantage of them. All projects have rights to publish maven sites to Nexus under the sites/${groupID}/ namespace for their project using a maven serverID of opendaylight-site.</p> <p>I would recommend that each <em>version</em> of a project publish to a sites/${groupID}/${version}/ so that things don't get stomped on since a maven site deploy overwrites anything at the root level it's deploying to, or possibly sites/${groupID}/${release_codename}/${version}/</p> <p><a href="https://git.opendaylight.org/gerrit/#/c/21776/" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/#/c/21776/</a></p> <p>fixes mvn site for the controller ... will try in the others.</p> <p>@Tony: Links are not working for me in target/site/index.html (wrong folder in links). Is that what you mean?</p> <p>Reopening.</p> <p>I disagree as there is no solution to this problem, yet.</p> <p>There is no browsable version of the mvn sites available that includes the javadoc et al.</p> <p>NB: New <a href="https://jira.opendaylight.org/browse/DOCS-33" title="javadoc.opendaylight.org" class="issue-link" data-issue-key="DOCS-33"><del>DOCS-33</del></a> ..</p> <p>I think this is resolved now at least I see javadoc here:</p> <p><a href="https://javadocs.opendaylight.org/org.opendaylight.controller/oxygen/" class="external-link" target="_blank" rel="nofollow noopener">https://javadocs.opendaylight.org/org.opendaylight.controller/oxygen/</a></p> <p>Feel free to reopen if anyone feels there's additional action to take here.</p> Blocks DOCS-33 RELENG-42 ODLPARENT-70 Duplicate CONTROLLER-1345 CONTROLLER-1347 Development External issue ID 2602 External issue URL Issue Type Rank 0|i01ly7: