JDK-8010495: Update JAXP NetBeans project - add support for generating javadoc
Hi guys, I'd like to propose a small change to jaxp/build.xml and jaxp/nbproject/project.xml - in order to allow editing JAXP sources in NetBeans, as well as generating the JAXP javadoc for previewing purposes. I actually stole the javadoc target from jdk/make/netbeans/common/shared.xml The changes are small & targeted at developers. There should be no impact on the build process. Here is the webrev: http://cr.openjdk.java.net/~dfuchs/JDK-8010495/jdk8/webrev.00/ best regards, -- daniel
Hi Daniel, Thanks for doing this. JAXP doesn't have these packages: "java/", "org/ietf/jgss/", and "org/omg/". Since this is the jaxp repo, it would be fine if only 'javax/' and 'org/' are included, or 'com/' be excluded. Regards, Joe On 3/25/2013 4:45 AM, Daniel Fuchs wrote:
Hi guys,
I'd like to propose a small change to jaxp/build.xml and jaxp/nbproject/project.xml - in order to allow editing JAXP sources in NetBeans, as well as generating the JAXP javadoc for previewing purposes.
I actually stole the javadoc target from jdk/make/netbeans/common/shared.xml
The changes are small & targeted at developers. There should be no impact on the build process.
Here is the webrev:
http://cr.openjdk.java.net/~dfuchs/JDK-8010495/jdk8/webrev.00/
best regards,
-- daniel
On 3/25/13 5:20 PM, huizhe wang wrote:
Hi Daniel,
Thanks for doing this.
JAXP doesn't have these packages: "java/", "org/ietf/jgss/", and "org/omg/". Since this is the jaxp repo, it would be fine if only 'javax/' and 'org/' are included, or 'com/' be excluded.
OK - I just copied the pattern shared by all jdk/make/netbeans projects - but I guess I can safely restrict the list to what is actually present in JAXP. That would make it: 203 <packageset dir="${jaxp.src.dir}" includes="${includes}" excludes="${excludes}"> 204 <or> 205 206 <filename name="javax/"/> 207 208 209 <filename name="org/w3c/"/> 210 <filename name="org/xml/sax/"/> 211 </or> -- daniel
Regards, Joe
On 3/25/2013 4:45 AM, Daniel Fuchs wrote:
Hi guys,
I'd like to propose a small change to jaxp/build.xml and jaxp/nbproject/project.xml - in order to allow editing JAXP sources in NetBeans, as well as generating the JAXP javadoc for previewing purposes.
I actually stole the javadoc target from jdk/make/netbeans/common/shared.xml
The changes are small & targeted at developers. There should be no impact on the build process.
Here is the webrev:
http://cr.openjdk.java.net/~dfuchs/JDK-8010495/jdk8/webrev.00/
best regards,
-- daniel
On 3/25/2013 9:35 AM, Daniel Fuchs wrote:
On 3/25/13 5:20 PM, huizhe wang wrote:
Hi Daniel,
Thanks for doing this.
JAXP doesn't have these packages: "java/", "org/ietf/jgss/", and "org/omg/". Since this is the jaxp repo, it would be fine if only 'javax/' and 'org/' are included, or 'com/' be excluded.
OK - I just copied the pattern shared by all jdk/make/netbeans projects - but I guess I can safely restrict the list to what is actually present in JAXP.
That would make it:
203 <packageset dir="${jaxp.src.dir}" includes="${includes}" excludes="${excludes}"> 204 <or> 205 206 <filename name="javax/"/> 207 208 209 <filename name="org/w3c/"/> 210 <filename name="org/xml/sax/"/> 211 </or>
I'm not familiar with this usage. Does the 'includes' attribute take precedence over the package names in <or> tags? Will they be ignored since 'includes' includes all packages. -Joe
-- daniel
Regards, Joe
On 3/25/2013 4:45 AM, Daniel Fuchs wrote:
Hi guys,
I'd like to propose a small change to jaxp/build.xml and jaxp/nbproject/project.xml - in order to allow editing JAXP sources in NetBeans, as well as generating the JAXP javadoc for previewing purposes.
I actually stole the javadoc target from jdk/make/netbeans/common/shared.xml
The changes are small & targeted at developers. There should be no impact on the build process.
Here is the webrev:
http://cr.openjdk.java.net/~dfuchs/JDK-8010495/jdk8/webrev.00/
best regards,
-- daniel
Hi Joe, On 3/25/13 5:52 PM, huizhe wang wrote:
On 3/25/2013 9:35 AM, Daniel Fuchs wrote:
On 3/25/13 5:20 PM, huizhe wang wrote:
Hi Daniel,
Thanks for doing this.
JAXP doesn't have these packages: "java/", "org/ietf/jgss/", and "org/omg/". Since this is the jaxp repo, it would be fine if only 'javax/' and 'org/' are included, or 'com/' be excluded.
OK - I just copied the pattern shared by all jdk/make/netbeans projects - but I guess I can safely restrict the list to what is actually present in JAXP.
That would make it:
203 <packageset dir="${jaxp.src.dir}" includes="${includes}" excludes="${excludes}"> 204 <or> 205 206 <filename name="javax/"/> 207 208 209 <filename name="org/w3c/"/> 210 <filename name="org/xml/sax/"/> 211 </or>
I'm not familiar with this usage. Does the 'includes' attribute take precedence over the package names in <or> tags? Will they be ignored since 'includes' includes all packages.
In other free form projects defined for JDK, 'includes' and 'excludes' are global properties defined in the project's properties file. They control which subset of the sources are considered part of the project - and are used by the compile target, the javadoc target, and also to select which files will be seen in NetBeans, etc... As far as I understand the <or> selector in packageset in the javadoc target defines the subset of the subset of the sources for which javadoc should be generated. So it's a way to scope the sources defined by includes/excludes down to the set of public packages for which api documentation is desired. I think we should keep it like that in JAXP - even though the javadoc target is currently the only target that would be affected by the definition of includes/excludes in jaxp/build.properties. -- daniel
-Joe
-- daniel
Regards, Joe
On 3/25/2013 4:45 AM, Daniel Fuchs wrote:
Hi guys,
I'd like to propose a small change to jaxp/build.xml and jaxp/nbproject/project.xml - in order to allow editing JAXP sources in NetBeans, as well as generating the JAXP javadoc for previewing purposes.
I actually stole the javadoc target from jdk/make/netbeans/common/shared.xml
The changes are small & targeted at developers. There should be no impact on the build process.
Here is the webrev:
http://cr.openjdk.java.net/~dfuchs/JDK-8010495/jdk8/webrev.00/
best regards,
-- daniel
On 3/26/2013 2:04 AM, Daniel Fuchs wrote:
Hi Joe,
On 3/25/13 5:52 PM, huizhe wang wrote:
On 3/25/2013 9:35 AM, Daniel Fuchs wrote:
On 3/25/13 5:20 PM, huizhe wang wrote:
Hi Daniel,
Thanks for doing this.
JAXP doesn't have these packages: "java/", "org/ietf/jgss/", and "org/omg/". Since this is the jaxp repo, it would be fine if only 'javax/' and 'org/' are included, or 'com/' be excluded.
OK - I just copied the pattern shared by all jdk/make/netbeans projects - but I guess I can safely restrict the list to what is actually present in JAXP.
That would make it:
203 <packageset dir="${jaxp.src.dir}" includes="${includes}" excludes="${excludes}"> 204 <or> 205 206 <filename name="javax/"/> 207 208 209 <filename name="org/w3c/"/> 210 <filename name="org/xml/sax/"/> 211 </or>
I'm not familiar with this usage. Does the 'includes' attribute take precedence over the package names in <or> tags? Will they be ignored since 'includes' includes all packages.
In other free form projects defined for JDK, 'includes' and 'excludes' are global properties defined in the project's properties file. They control which subset of the sources are considered part of the project - and are used by the compile target, the javadoc target, and also to select which files will be seen in NetBeans, etc...
Yeh, there may be dependencies among different JDK projects. We don't have that for now. But I'm ok.
As far as I understand the <or> selector in packageset in the javadoc target defines the subset of the subset of the sources for which javadoc should be generated. So it's a way to scope the sources defined by includes/excludes down to the set of public packages for which api documentation is desired.
I think we should keep it like that in JAXP - even though the javadoc target is currently the only target that would be affected by the definition of includes/excludes in jaxp/build.properties.
I see. <or> gives impression that the packages selected within the selector only take effect when includes/excludes is not defined, which was why I was asking. Thanks, Joe
-- daniel
-Joe
-- daniel
Regards, Joe
On 3/25/2013 4:45 AM, Daniel Fuchs wrote:
Hi guys,
I'd like to propose a small change to jaxp/build.xml and jaxp/nbproject/project.xml - in order to allow editing JAXP sources in NetBeans, as well as generating the JAXP javadoc for previewing purposes.
I actually stole the javadoc target from jdk/make/netbeans/common/shared.xml
The changes are small & targeted at developers. There should be no impact on the build process.
Here is the webrev:
http://cr.openjdk.java.net/~dfuchs/JDK-8010495/jdk8/webrev.00/
best regards,
-- daniel
Hi, Please find below a revised patch: <http://cr.openjdk.java.net/~dfuchs/JDK-8010495/jdk8/webrev.01/> I had oversimplified the changes in project.xml. It seems you need to declare a source folder of type 'java' as well as a compilation-unit in order for 'Find Usage' to work properly in the editor. I have also restrained the packageset for the javadoc target as suggested by Joe. -- daniel On 3/25/13 12:45 PM, Daniel Fuchs wrote:
Hi guys,
I'd like to propose a small change to jaxp/build.xml and jaxp/nbproject/project.xml - in order to allow editing JAXP sources in NetBeans, as well as generating the JAXP javadoc for previewing purposes.
I actually stole the javadoc target from jdk/make/netbeans/common/shared.xml
The changes are small & targeted at developers. There should be no impact on the build process.
Here is the webrev:
http://cr.openjdk.java.net/~dfuchs/JDK-8010495/jdk8/webrev.00/
best regards,
-- daniel
Hi Daniel, Looks good. The docs are "for preview purposes only" anyways, I shouldn't be picky :-) Thanks, Joe On 3/28/2013 12:37 PM, Daniel Fuchs wrote:
Hi,
Please find below a revised patch:
<http://cr.openjdk.java.net/~dfuchs/JDK-8010495/jdk8/webrev.01/>
I had oversimplified the changes in project.xml. It seems you need to declare a source folder of type 'java' as well as a compilation-unit in order for 'Find Usage' to work properly in the editor.
I have also restrained the packageset for the javadoc target as suggested by Joe.
-- daniel
On 3/25/13 12:45 PM, Daniel Fuchs wrote:
Hi guys,
I'd like to propose a small change to jaxp/build.xml and jaxp/nbproject/project.xml - in order to allow editing JAXP sources in NetBeans, as well as generating the JAXP javadoc for previewing purposes.
I actually stole the javadoc target from jdk/make/netbeans/common/shared.xml
The changes are small & targeted at developers. There should be no impact on the build process.
Here is the webrev:
http://cr.openjdk.java.net/~dfuchs/JDK-8010495/jdk8/webrev.00/
best regards,
-- daniel
participants (2)
-
Daniel Fuchs
-
huizhe wang