[RELENG-3] Javadocs are not being generated for controller APIs Created: 16/Jan/15  Updated: 28/Feb/18  Resolved: 27/Feb/18

Status: Open
Project: releng
Component/s: Autorelease
Affects Version/s: unspecified
Fix Version/s: Oxygen

Type: Bug
Reporter: Jan Medved Assignee: Thanh Ha (zxiiro)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

Operating System: All
Platform: All

Issue Links:
Blocks
is blocked by DOCS-33 javadoc.opendaylight.org Open
is blocked by RELENG-42 Produce JavaDoc site for entire release Open
is blocked by ODLPARENT-70 New odlparent Maven Profile / Parent ... Resolved
Duplicate
is duplicated by CONTROLLER-1345 Link from wiki to apidocs in jenkins ... Resolved
is duplicated by CONTROLLER-1347 javadoc link in wiki dead Resolved
External issue ID: 2602

 Description   

It looks like javadocs are not being generated for the controller. All pointers to the existing latest generated javadocs (https://jenkins.opendaylight.org/controller/job/controller-merge/lastSuccessfulBuild/artifact/target/apidocs/index.html) are invalid.

It would also be good to put the generated javadocs as artefacts into nexus, rather than have them in jenkins.

 Comments   
Comment by Carol Sanders [ 02/Jun/15 ]

Generated, stored in nexus but not html form.

this should be fixed in releng builder in odlparent.

Comment by Jan-Simon Moeller [ 02/Jun/15 ]

Just my 0,02$:

  • Each release and master should have hosted folder where the javadocs + yang +
    other APIs are documented and can be linked to from the wiki.
  • The folder structure needs to be static to keep links intact. Still the doc
    should be autogenerated/published by jenkins from the respective branches.

Can we implement that ? I'd volunteer to fix the wiki links once we have this up.

Comment by Tony Tkacik [ 03/Jun/15 ]

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.

Comment by Andrew Grimberg [ 03/Jun/15 ]

Maven sites are 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.

I would recommend that each version 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}/

Comment by Jan-Simon Moeller [ 03/Jun/15 ]

https://git.opendaylight.org/gerrit/#/c/21776/

fixes mvn site for the controller ... will try in the others.

@Tony: Links are not working for me in target/site/index.html (wrong folder in links). Is that what you mean?

Comment by Jan-Simon Moeller [ 04/Sep/15 ]

Reopening.

I disagree as there is no solution to this problem, yet.

There is no browsable version of the mvn sites available that includes the javadoc et al.

Comment by Michael Vorburger [ 28/Feb/17 ]

NB: New DOCS-33 ..

Comment by Thanh Ha (zxiiro) [ 27/Feb/18 ]

I think this is resolved now at least I see javadoc here:

https://javadocs.opendaylight.org/org.opendaylight.controller/oxygen/

Feel free to reopen if anyone feels there's additional action to take here.

Generated at Wed Feb 07 20:37:15 UTC 2024 using Jira 8.20.10#820010-sha1:ace47f9899e9ee25d7157d59aa17ab06aee30d3d.