Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [cross-project-issues-dev] Linking to platform javadocs

I don't have a full answer, but you can at least link to the "latest" released version of a class like this:
http://help.eclipse.org/topic//org.eclipse.platform.doc.isv/reference/api/org/eclipse/core/runtime/ListenerList.html

Note that "indigo/topic/" has been replaced by "topic//" with a double slash.

Here are some bugs about this topic:
https://bugs.eclipse.org/283856
https://bugs.eclipse.org/351037
https://bugs.eclipse.org/371550


If your doc plug-in will end up in the same infocenter as the link target, then the recommended way is to use PLUGINS_ROOT in the href, see
http://help.eclipse.org/indigo/topic/org.eclipse.platform.doc.isv/guide/ua_help_content_files.htm

HTH,
Markus



From: Alexander Nyßen <alexander.nyssen@xxxxxxxxx>
To: Cross project issues <cross-project-issues-dev@xxxxxxxxxxx>,
Date: 2012-03-13 23:57
Subject: [cross-project-issues-dev] Linking to platform javadocs





Hi all,

I am currently struggling with how to properly link the javadocs of our plug-ins (org.eclipse.draw2d.doc.isv and org.eclipse.gef.doc.isv) agains those of the platform (i.e. org.eclipse.platform.doc.isv) and I thought I could find help here.

Currently, we have a javadoc.options file within each of our doc.isv plug-ins, which contain link statements of the form:

-link http://docs.oracle.com/javase/1.4.2/docs/api/
-link http://help.eclipse.org/indigo/topic/org.eclipse.platform.doc.isv/reference/api/

That seems to work in principle, but of course has the disadvantage that it links our javadocs to an outdated platform javadoc (namely that of the last release). I would rather like to link it to the current platform documentation instead, i.e. 4.2 for the Juno. Unfortunately no Juno help pages seem to be online yet.

When linking from org.eclipse.gef.doc.isv to org.eclipse.draw2d.doc.isv, I further have the problem that there is no Javadoc for Draw2d contained on help.eclipse.org/indigo currently, so I may not even link to an outdated version (we had problems in producing javadoc with the old build system, so javadoc was not published properly for the indigo releases) and will have to wait for the help.eclipse.org/juno being first populated.

How is that usually handled? Is the help.eclipse.org/Juno populated initially before the final release? Is there a way to provide a stable URL to point to the eclipse help of the latest release in such cases?

Cheers,
Alexander

--  
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

http://www.itemis.de
alexander.nyssen@xxxxxxxxx

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

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



Back to the top