[MNT-16392] Java Public API TransactionService docs contain broken links Created: 03-Feb-16  Updated: 20-Jul-16  Resolved: 23-Jun-16

Status: Closed
Project: Service Packs and Hot Fixes
Component/s: Foundation Java APIs
Affects Version/s: 5.1
Fix Version/s: 5.1.1

Type: Bug
Reporter: Tony Bedford [X] (Inactive) Assignee: Closed Bugs (Inactive)
Resolution: Fixed Votes: 0
Labels: JavaDocs, rn511, triaged
Remaining Estimate: 0 minutes
Time Spent: 3 hours, 30 minutes
Original Estimate: Not Specified

Issue Links:
Related
Bug Priority:
Category 3
Build Location: https://releases.alfresco.com/Enterprise-5.1/5.1.1/5.1.1/build-00138/ALL/

 Description   

The JavaDocs generated for the TransactionService contains bad links:

http://dev.alfresco.com/resource/docs/java/org/alfresco/service/transaction/TransactionService.html

The links to UserTransaction and Status, which reference the Oracle documentation appear to be broken.

It may be as simple as changing "javase" to "javaee" to fix the links.



 Comments   
Comment by Gethin James [X] (Inactive) [ 14-Apr-16 ]

javax.transaction.UserTransaction and javax.transaction.Status are not part of the Java JDK. The both belong in the jta-1.0.1b.jar I would not expect them to link to the Oracle documentation.

When I am generating the javadoc locally there doesn't seem to be a link. java version "1.7.0_80". I will discuss it with Samuel Langlois [X].

Comment by Samuel Langlois [X] (Inactive) [ 14-Apr-16 ]

The maven-javadoc-plugin has hardcoded values of URLs where the Oracle SDK Javadoc is available (see these values here)
However, this doesn't work for these 2 classes, because as you noticed, they are in the JavaEE Javadoc : https://docs.oracle.com/javaee/7/api/ rather than http://docs.oracle.com/javase/7/docs/api/

We can override this hardcoded link, but of course we would lose all the links that work currently, because the JavaEE Javadoc doesn't include the JavaSE one.
We could also provide both links to the maven-javadoc-plugin (see documentation here), but the links are generated based on the java package, and javax.transaction exists in both Javadoc, with different classes...

In short, I'm afraid we either have to remove these links from our javadoc, or to hardcode them to the JavaEE Javadoc.

Comment by Gethin James [X] (Inactive) [ 14-Apr-16 ]

After discussing with Samuel Langlois [X], I have removed the links but kept them formatted as classes with the fully qualified name.

Comment by Tony Bedford [X] (Inactive) [ 07-Jun-16 ]

If I go to here:

http://dev.alfresco.com/resource/docs/java/org/alfresco/service/transaction/TransactionService.html

and then click UserTransaction in Method Summary the link is still broken.

Generated at Sat Mar 06 23:34:33 GMT 2021 using Jira 7.13.15#713015-sha1:7c5ddd2c3e1709974ae9c48c17df8edd3919fe2c.