Skip to main content
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [cross-project-issues-dev] Javadoc generation / package-list
Hi Eike,

I think the easiest way will probably be to download and unzip the latest org.eclipse.platform.doc.isv bundle (the one in your target) during build and to have the javadoc tool link offline to it. I have built-in the same for Draw2d and GEF (where the doc plug-ins specify an optional dependency to the org.eclipse.platform.doc.isv bundle so the maven dependency plug-in can be used to make it available during build-time). We don't use Ant's javadoc task but invoke the javadoc tool directly (from ant), but you may take a look at the options we use for linking to the platform doc: http://git.eclipse.org/c/gef/org.eclipse.gef.git/tree/org.eclipse.draw2d.doc.isv/javadocOptions.txt

Cheers,
Alexander

Am 10.06.2012 um 19:46 schrieb Eike Stepper:

Hi Ed,

Thanks for your answer but I don't understand how the javadoc tool in my Ant build can resolve such a link to the package-list file in the Platform docs ;-(

Is it possible that you're talking about links that you *manually* write into your own docs? The ones I'm talking about are created by the javadoc tool and that requires access to the package-list files.

Cheers
/Eike

----
http://www.esc-net.de
http://thegordian.blogspot.com
http://twitter.com/eikestepper




Am 10.06.2012 19:15, schrieb Ed Willink:
Hi Eike

I use /help/topic/plugin-name...

Regards

Ed Willink

On 10/06/2012 17:45, Eike Stepper wrote:
Hi,

Our Java code uses many Platform interfaces and classes and when we would like to have hrefs to the Platform Javadocs
in our generated Javadocs. The Ant script we're using contains this:

<javadoc ...>
...

<link href="" />

</javadoc>

Unfortunately no clickable links end up in our docs. I have the feeling this is because the help center servlet
renders a full frameset when <javadoc> requests the package-list file (instead of returning just the file contents).

Is there a way to properly link with other doc plugins in the shared help center?

Cheers
/Eike

----
http://www.esc-net.de
http://thegordian.blogspot.com
http://twitter.com/eikestepper


_______________________________________________
cross-project-issues-dev mailing list
cross-project-issues-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/cross-project-issues-dev


-----
No virus found in this message.
Checked by AVG - www.avg.com
Version: 2012.0.2178 / Virus Database: 2433/5060 - Release Date: 06/10/12



_______________________________________________
cross-project-issues-dev mailing list
cross-project-issues-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/cross-project-issues-dev

--  
Dr. Alexander Nyßen
Dipl.-Inform.
Software-Engineer

Telefon: +49 (0) 231 / 98 60-210
Telefax: +49 (0) 231 / 98 60-211
Mobil: +49 (0) 151 /  17396743


itemis AG
Am Brambusch 15-24
44536 Lünen

Rechtlicher Hinweis:

Amtsgericht Dortmund, HRB 20621

Vorstand: Jens Wagener (Vors.), Wolfgang Neuhaus, Dr. Georg Pietrek, Jens Trompeter, Sebastian Neus

Aufsichtsrat: Dr. Burkhard Igel (Vors.), Stephan Grollmann, Michael Neuhaus

Back to the top