Bug 1008554

Summary: Missing javadoc for org.jboss.xts
Product: [JBoss] JBoss Enterprise Application Platform 6 Reporter: Jakub Cechacek <jcechace>
Component: OtherAssignee: Yong Yang <yyang>
Status: CLOSED CURRENTRELEASE QA Contact: Jakub Cechacek <jcechace>
Severity: high Docs Contact:
Priority: unspecified    
Version: 6.2.0CC: dosoudil, jkudrnac
Target Milestone: CR1   
Target Release: EAP 6.2.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2013-12-15 16:23:02 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On: 1026701    
Bug Blocks:    

Description Jakub Cechacek 2013-09-16 15:09:52 UTC
Current javadoc is missing documentation for following jars and packages 

/home/jcechace/tools/eap/eap6/620/jboss-eap-6.2/modules/system/layers/base/org/jboss/xts/main/jbossxts-4.17.9.Final-redhat-1.jar
1 missing:
   org.jboss.jbossts.xts.bridge.at
/home/jcechace/tools/eap/eap6/620/jboss-eap-6.2/modules/system/layers/base/org/jboss/xts/main/jbosstxbridge-4.17.9.Final-redhat-1.jar
3 missing:
   org.jboss.jbossts.txbridge.outbound
   org.jboss.jbossts.txbridge.inbound
   org.jboss.jbossts.txbridge.utils

Comment 1 Misty Stanley-Jones 2013-10-10 03:16:56 UTC
I'm not sure what the right component is for Javadoc bugs, but Documentation should be used for formal documentation maintained by Content Services. Javadoc does not fall under this category. Maybe we need a new component for it?

Comment 2 Yong Yang 2013-10-12 08:14:29 UTC
This artifact was excluded from javadoc generation before 6.2.0 due to some error. Now it has been fixed in Jenkins, https://jenkins.mw.lab.eng.bos.redhat.com/hudson/job/EAP6-javadoc/75/, and will be included in next ER. 


FYI:
$ cat build/javadoc/artifactsBlacklist.txt 
org.jboss.as:jboss-as-controller-client
org.jboss:jboss-dmr
org.jboss.jbossts:jbossxts
org.jboss.jbossts:jbossxts-api
org.jboss.weld:weld-core
org.picketbox:picketbox-commons
xalan:serializer
org.apache.ws.security:wss4j

Comment 3 Yong Yang 2013-10-18 10:24:43 UTC
These javadocs are generated in EAP6.2.0 ER6.

Comment 4 Jakub Cechacek 2013-10-22 07:39:18 UTC
The following package still remains missing in docs for 6.2.0.ER6

/home/jcechace/tools/eap/eap6/620/er6/jboss-eap-6.2/modules/system/layers/base/org/jboss/xts/main/jbossxts-4.17.12.Final-redhat-1.jar
1 missing:
   org.jboss.jbossts.xts.bridge.at

Comment 5 Yong Yang 2013-10-24 05:39:20 UTC
No org/jboss/jbossts/xts/bridge/ in jbossxts sources jar, need to rebuild  org.jboss.jbossts-narayana-all to solve this issue.


[yyang@dhcp-17-104 javadoc-er6]$ jar tf localRepo/org/jboss/jbossts/xts/jbossxts/4.17.12.Final-redhat-1/jbossxts-4.17.12.Final-redhat-1.jar | grep bridge
org/jboss/jbossts/xts/bridge/
org/jboss/jbossts/xts/bridge/at/
org/jboss/jbossts/xts/bridge/at/BridgeWrapper.class
META-INF/maven/org.jboss.jbossts.xts/bridge/
META-INF/maven/org.jboss.jbossts.xts/bridge/pom.xml
META-INF/maven/org.jboss.jbossts.xts/bridge/pom.properties

[yyang@dhcp-17-104 javadoc-er6]$ jar tf localRepo/org/jboss/jbossts/xts/jbossxts/4.17.12.Final-redhat-1/jbossxts-4.17.12.Final-redhat-1-sources.jar | grep bridge
[yyang@dhcp-17-104 javadoc-er6]$

Comment 6 Vladimir Dosoudil 2013-10-24 07:13:22 UTC
The source for BridgeWrapper is located in corresponding maven (sub-)module (../bridge/). Including BridgeWrapper.class in jbossxts artifact is configured by using maven-shade-plugin.

Comment 7 Yong Yang 2013-11-05 02:46:44 UTC
Hi Vladimir, to keep the sources jar and binary jar consistent, is it possible to remove BridgeWrapper.class from binary jar or add BridgeWrapper.java to sources jar?

Comment 8 Vladimir Dosoudil 2013-11-05 07:48:17 UTC
Optional parameter createSourcesJar has been added into configuration of maven-shade-plugin for jbossxts. Fixed jbossxts source jar will be available in the next builds of jbossts/narayana i.e. newer than 4.17.15.Final-redhat-1.

Comment 9 Vladimir Dosoudil 2013-11-05 11:34:55 UTC
jbossxts sources jar fixed in https://brewweb.devel.redhat.com/buildinfo?buildID=306066

Comment 10 Jakub Cechacek 2013-11-14 11:19:14 UTC
Verified 6.2.0.CR1