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 40959 - Make it simple to link <api /> to another NetBeans API
Summary: Make it simple to link <api /> to another NetBeans API
Status: RESOLVED FIXED
Alias: None
Product: www
Classification: Unclassified
Component: Builds & Repositories (show other bugs)
Version: 4.x
Hardware: PC Linux
: P1 blocker (vote)
Assignee: Jaroslav Tulach
URL:
Keywords:
Depends on:
Blocks: 40960
  Show dependency tree
 
Reported: 2004-03-12 15:21 UTC by Jaroslav Tulach
Modified: 2005-09-05 10:06 UTC (History)
0 users

See Also:
Issue Type: TASK
Exception Reporter:


Attachments
Implementation of general idea (at least ModuleInstall links correctly to SharedClassObject) (42.03 KB, text/plain)
2005-04-20 17:40 UTC, Jaroslav Tulach
Details
Modifying the javadoctools, to dynamically generate information about already build javadocs (only for modules that are not known currently, those are pregenerated) and canonicalizing names of javadoc dirs to match the dashed code base name of the module (18.77 KB, text/plain)
2005-04-25 13:47 UTC, Jaroslav Tulach
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Jaroslav Tulach 2004-03-12 15:21:07 UTC
As the number of independent NetBeans modules is
growing, it became uncomfortable to use <api
url="http://www.netbeans.org/" /> for mutual
references. The suggestion is to use 

<api nbapi="Loaders" /> 

instead.
Comment 1 Jesse Glick 2004-03-12 15:59:52 UTC
While you're at it, consider keeping some data about each API in a
central place in nbbuild/javadoctools/ so that template.xml doesn't
need to hardcode everything. TBD exactly how this should work.
Comment 2 Jaroslav Tulach 2004-10-16 07:42:08 UTC
I am not sure I can handle this for 4.0. Of course, if there is a pressing need, I 
can, but otherwise this may wait a while. 
 
The solution I had in mind was to modify javadoctools/template.xml to not 
hardcode the list of tokens to replace, but generate them. When we would be 
processing openide/util we would generate mapping from @OPENIDE/UTIL@ to 
proper URL in some file(s). All other invocations of template.xml would use 
(include) that file and could then refer to all the mappings generated in advance.  
 
The mappings should include references to roots of javadocs (like 
@OPENIDE/UTIL@) and also to definitions of apis from arch*.xml answers (like 
@API/GROUP-JAVA/NAME-LoadersAPI@), the arch*xml XSLT would then 
understand <api ref="..." /> tag that would be replaced by <a 
href="@API/GROUP-...." />, so regular uses of the arch*xml infra would not need 
to know the encoding convetion of the @...@ form. 
 
Is this the right direction? 
Comment 3 Jesse Glick 2004-10-16 14:58:43 UTC
General idea sounds right to me.
Comment 4 Jaroslav Tulach 2005-04-20 16:27:14 UTC
Let's try this, or at least parts of this for 4.2. I believe I have good  
enough patch for javadocs to generate its references. I plan to apply it on  
Friday. 
Comment 5 Jaroslav Tulach 2005-04-20 17:40:36 UTC
Created attachment 21778 [details]
Implementation of general idea (at least ModuleInstall links correctly to SharedClassObject)
Comment 6 Jesse Glick 2005-04-23 00:30:37 UTC
If it works, OK...

1. Do you have a script or something to generate the included XML fragments?

2. Shouldn't javadoc.name overrides be removed from all project.properties?
Comment 7 Jaroslav Tulach 2005-04-25 13:47:53 UTC
Created attachment 21849 [details]
Modifying the javadoctools, to dynamically generate information about already build javadocs (only for modules that are not known currently, those are pregenerated) and canonicalizing names of javadoc dirs to match the dashed code base name of the module
Comment 8 Jaroslav Tulach 2005-07-07 15:03:11 UTC
Standardized use 
 
@your-module-code-base-name@  
 
in the javadoc or arch questions as described at  
http://openide.netbeans.org/tutorial/api.html#write