This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.
Summary: | Project's "Creating Javadoc" property page needs an option and a field for specifying the overview comment file. | ||
---|---|---|---|
Product: | java | Reporter: | rptmaestro <rptmaestro> |
Component: | Project | Assignee: | Tomas Zezula <tzezula> |
Status: | NEW --- | ||
Severity: | blocker | CC: | jglick, jrojcek |
Priority: | P2 | Keywords: | API, UI |
Version: | 4.x | ||
Hardware: | All | ||
OS: | All | ||
URL: | http://projects.netbeans.org/nonav/buildsys/j2se-project-ui-spec-promoe.html#Build_Documenting | ||
Issue Type: | ENHANCEMENT | Exception Reporter: | |
Bug Depends on: | 51151, 57753 | ||
Bug Blocks: | 41537 |
Description
rptmaestro
2004-10-06 18:52:38 UTC
Perhaps the best way to do this would be to add an "Additional Javadoc Options" field similar to the "Additional Compiler Options" field on the "Compiling Sources" property page. True, the build-impl.xml could use additionalparam="${javadoc.args}" with default value of javadoc.args set to "" in project.properties and customizable in a simple text field in "Generating Javadoc". Workaround is of course to override build-impl.xml#-javadoc-build in build.xml to do what you want. In general this is more flexible; for example, you can add nested arguments to the Ant task that will properly handle spaces, use some property references, define groups, ad nauseam. (It is also safer in some ways since the Ant task provides various kinds of syntax and argument checking that are lost when you use the raw 'additionalparam' attribute.) The GUI will never attempt to provide the full power possible by writing your own target. *** Issue 50187 has been marked as a duplicate of this issue. *** Adding API keyword because new property is needed. The spec is in the URL field. Checking in src/org/netbeans/modules/java/j2seproject/J2SEProjectGenerator.java; /cvs/java/j2seproject/src/org/netbeans/modules/java/j2seproject/J2SEProjectGenerator.java,v <-- J2SEProjectGenerator.java new revision: 1.35; previous revision: 1.34 done Processing log script arguments... More commits to come... Checking in src/org/netbeans/modules/java/j2seproject/resources/build-impl.xsl; /cvs/java/j2seproject/src/org/netbeans/modules/java/j2seproject/resources/build-impl.xsl,v <-- build-impl.xsl new revision: 1.51; previous revision: 1.50 done Processing log script arguments... More commits to come... Checking in src/org/netbeans/modules/java/j2seproject/ui/customizer/Bundle.properties; /cvs/java/j2seproject/src/org/netbeans/modules/java/j2seproject/ui/customizer/Bundle.properties,v <-- Bundle.properties new revision: 1.46; previous revision: 1.45 done Checking in src/org/netbeans/modules/java/j2seproject/ui/customizer/CustomizerJavadoc.form; /cvs/java/j2seproject/src/org/netbeans/modules/java/j2seproject/ui/customizer/CustomizerJavadoc.form,v <-- CustomizerJavadoc.form new revision: 1.7; previous revision: 1.6 done Checking in src/org/netbeans/modules/java/j2seproject/ui/customizer/CustomizerJavadoc.java; /cvs/java/j2seproject/src/org/netbeans/modules/java/j2seproject/ui/customizer/CustomizerJavadoc.java,v <-- CustomizerJavadoc.java new revision: 1.9; previous revision: 1.8 done Checking in src/org/netbeans/modules/java/j2seproject/ui/customizer/J2SEProjectProperties.java; /cvs/java/j2seproject/src/org/netbeans/modules/java/j2seproject/ui/customizer/J2SEProjectProperties.java,v <-- J2SEProjectProperties.java new revision: 1.42; previous revision: 1.41 done Reopening as the additional javadoc properties are not wsell suited for that. We really need an extra field and we also need to use the ANT attribute overview. What's wrong with using the additional Javadoc properties for this? Should work fine, so long as you use a relative path for the overview file. The trouble (at least for me) is relative to what. If you don't put there a full path javadoc will end with: "Error while reading file overview.html" Ah, because build-impl.xml is passing e.g. <arg line="-overview whatever.html"/> rather than the correct <arg value="-overview"/> <arg location="whatever.html"/> You could put in the text field -overview ${basedir}/whatever.html though this is hardly obvious if you don't know Ant. We could just fix the hint text for Additional Javadoc Options to say this. That would be trivial. Do it for 4.1? 1) I would not reccomend to fix the hint as putting ant props inti the customizer does not work very well. The value will be "absolutized" after next open of customizer anyway. 2) Well if we go with <arg value="-overview"/> <arg location="whatever.html"/> i think we eill have to regenarete the script every time the value changes (at least when -overview can be found in the additional params) I fear the ANT won't handle the empty location attr gracefully. And anyway there will have to be special logic scanning the additional params value for the overview. I.e. I wopuld rather go with extra field and using the Overview parameter which is available in the Javadoc ANT target. Re. #1 (evaluation of properties in text fields) - don't you consider this a bug anyway? Obviously not for 4.1. *** Issue 65143 has been marked as a duplicate of this issue. *** |