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 34473 - Use javadoctools to generate API
Summary: Use javadoctools to generate API
Status: VERIFIED FIXED
Alias: None
Product: xml
Classification: Unclassified
Component: API (show other bugs)
Version: 3.x
Hardware: All All
: P3 blocker (vote)
Assignee: _ rkubacki
URL:
Keywords: API
Depends on: 34382
Blocks:
  Show dependency tree
 
Reported: 2003-06-19 08:52 UTC by Jaroslav Tulach
Modified: 2007-09-25 01:29 UTC (History)
2 users (show)

See Also:
Issue Type: DEFECT
Exception Reporter:


Attachments
patch (8.65 KB, patch)
2005-03-16 21:10 UTC, _ rkubacki
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Jaroslav Tulach 2003-06-19 08:52:44 UTC
The current page with list of all API at
http://www.netbeans.org/download/dev/javadoc/
is ugly and shall be replaced by something nicer.
When issue 34382 is implemented only modules using
nbbuild/javadoctools/template.xml and providing
their arch.xml answers will be included in the
list. Please rewrite your module to use that
infrastructure to generate the javadoc. See 
http://openide.netbeans.org/tutorial/api.html
for more info.
Comment 1 Jaroslav Tulach 2003-06-19 09:02:24 UTC
I have made this issue depend on issue 34382, but only to track the
dependencies. You can switch to javadoctools at any time, just you should know
that when issue 34382 is implemented, your API will not be visible without using
javadoctools.
 
Comment 2 _ pkuzel 2003-06-19 12:41:23 UTC
I prefer generating such structure without the template by using
sequence of Ant tasks. The less dependencies the better.

Is there any advantage of using the template (something I cannot
achieve with javadoc task and several copy tasks)?
Comment 3 Jaroslav Tulach 2003-06-19 15:53:19 UTC
openide does everything by hand (calls to all the ant tasks and does
the copying), so it is possible to do it, but if you choose this way,
be warned that it is an unsupported one. May break anytime.

We plan to change openide/build.xml to use the template.xml after the
compile time separation of openide.jar.
Comment 4 Petr Pisl 2004-01-21 15:23:28 UTC
This is not so crucial issue, so I changed the  priority to P3.
Comment 5 _ rkubacki 2005-03-16 21:10:58 UTC
Created attachment 20909 [details]
patch
Comment 6 _ rkubacki 2005-03-16 21:15:29 UTC
The javadoc can be built - openAPIs are linked, JDK too, no need to care about
SAX as the packages are in JDK now. 

There is a problem with apichanges.xml that contains more changes linked to one
version. Jardo, any idea how to fix it? When this is done we can also remove
generated apichanges.html.

Another problem is arch document (xml/arch/answers.xml) that does not validate
so I ignored it now. 

Also the content says about finalization of API in 3.4 release :-)

Should I commit it as it is?

Comment 7 Jaroslav Tulach 2005-03-17 17:42:05 UTC
Usage of <change id="blabla"> shall help. 

If you want to list the API on the index page (and that is the request in first
description) then you need to change nbbuild/build.properties to include this
module and also somehow convince arch document to validate and contain at least
one exported api.
Comment 8 _ rkubacki 2005-03-18 11:42:41 UTC
Checking in xml/api/build.xml;
/cvs/xml/api/build.xml,v  <--  build.xml
new revision: 1.37; previous revision: 1.36
done
Checking in xml/api/doc/changes/apichanges.xml;
/cvs/xml/api/doc/changes/apichanges.xml,v  <--  apichanges.xml
new revision: 1.16; previous revision: 1.15
done
Checking in xml/api/nbproject/project.properties;
/cvs/xml/api/nbproject/project.properties,v  <--  project.properties
new revision: 1.2; previous revision: 1.1
done
Checking in xml/api/src/org/netbeans/spi/xml/cookies/DefaultXMLProcessorDetail.java;
/cvs/xml/api/src/org/netbeans/spi/xml/cookies/DefaultXMLProcessorDetail.java,v 
<--  DefaultXMLProcessorDetail.java
new revision: 1.7; previous revision: 1.6
done
Checking in xml/api/src/org/netbeans/spi/xml/cookies/TransformableSupport.java;
/cvs/xml/api/src/org/netbeans/spi/xml/cookies/TransformableSupport.java,v  <-- 
TransformableSupport.java
new revision: 1.22; previous revision: 1.21
done
Checking in xml/arch/answers.xml;
/cvs/xml/arch/answers.xml,v  <--  answers.xml
new revision: 1.3; previous revision: 1.2
done
Comment 9 _ rkubacki 2005-03-18 11:44:28 UTC
thanks for hint Jarda. now it is built with 'ant -f nbbuild/build.xml
build-javadoc'. OTOH the arch description is out of date.
Comment 10 Jaroslav Tulach 2005-03-21 13:45:06 UTC
I can see it:
http://www.netbeans.org/download/dev/javadoc/#def-api-XML%20Support