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.

Bug 50039 - Project's "Creating Javadoc" property page needs an option and a field for specifying the overview comment file.
Summary: Project's "Creating Javadoc" property page needs an option and a field for sp...
Status: NEW
Alias: None
Product: java
Classification: Unclassified
Component: Project (show other bugs)
Version: 4.x
Hardware: All All
: P2 blocker (vote)
Assignee: Tomas Zezula
Keywords: API, UI
: 50187 65143 (view as bug list)
Depends on: 51151 57753
Blocks: 41537
  Show dependency tree
Reported: 2004-10-06 18:52 UTC by rptmaestro
Modified: 2011-08-31 14:05 UTC (History)
2 users (show)

See Also:
Exception Reporter:


Note You need to log in before you can comment on or make changes to this bug.
Description rptmaestro 2004-10-06 18:52:38 UTC
In the "Creating Javadoc" build property page, 
there needs to be included an option and a field 
for specifying an overview comment file 
according to the javadoc -overview option.
Comment 1 rptmaestro 2004-10-06 18:55:36 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.
Comment 2 Jesse Glick 2004-10-07 15:03:34 UTC
True, the build-impl.xml could use additionalparam="${javadoc.args}"
with default value of javadoc.args set to "" in 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.
Comment 3 Jesse Glick 2004-10-08 23:09:18 UTC
*** Issue 50187 has been marked as a duplicate of this issue. ***
Comment 4 David Konecny 2004-11-03 15:05:32 UTC
Adding API keyword because new property is needed.
Comment 5 jrojcek 2004-12-08 17:28:59 UTC
The spec is in the URL field.
Comment 6 Petr Hrebejk 2005-01-21 15:09:41 UTC
Checking in
new revision: 1.35; previous revision: 1.34
Processing log script arguments...
More commits to come...
Checking in
 <--  build-impl.xsl
new revision: 1.51; previous revision: 1.50
Processing log script arguments...
More commits to come...
Checking in
new revision: 1.46; previous revision: 1.45
Checking in
 <--  CustomizerJavadoc.form
new revision: 1.7; previous revision: 1.6
Checking in
new revision: 1.9; previous revision: 1.8
Checking in
new revision: 1.42; previous revision: 1.41
Comment 7 Petr Hrebejk 2005-04-13 10:13:04 UTC
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.
Comment 8 Jesse Glick 2005-04-13 13:52:50 UTC
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.
Comment 9 Petr Hrebejk 2005-04-13 15:19:57 UTC
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"
Comment 10 Jesse Glick 2005-04-13 17:59:28 UTC
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?
Comment 11 Petr Hrebejk 2005-04-14 17:27:49 UTC
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.

Comment 12 Jesse Glick 2005-04-14 17:56:48 UTC
Re. #1 (evaluation of properties in text fields) - don't you consider this a bug
Comment 13 Jesse Glick 2005-10-04 00:15:46 UTC
Obviously not for 4.1.
Comment 14 Tomas Zezula 2005-10-04 10:34:09 UTC
*** Issue 65143 has been marked as a duplicate of this issue. ***