Hi Adolfo
I agree a). But surely the references are created by the Javadoc
script, so its just necessary to change the Javadoc script onvce for
each release.
I prefer www as the location, but I see that Xtext is on downloads,
so I'm happy with either location.
Regards
Ed
On 12/04/2011 17:43, Adolfo Sánchez-Barbudo Herrera wrote:
mmm
Another side effect of removing javadoc from the doc plugin...
>.< ... Some alternative ideas to correct this:
a) Changing Links so that they have absolute URLs to a
javadoc-per-release area from downloads (i.e http://download.eclipse.org/modeling/mdt/ocl/javadoc/3.1.0/)
+ No extra size in doc bundle.
- Links need to be revised every release, so we make them point to
the correct URL.
+ Every release will have a link to the corresponding Javadoc
(MDT/OCL 3.1.0 Help would have links pointing to MDT/OCL 3.1.0
Javadoc)
b) Changing Links so that they have an absolute URLs to a unique
javadoc area from downolads (i.e http://download.eclipse.org/modeling/mdt/ocl/javadoc)
+ No extra size in doc bundles.
+ Links don't need to be revised every release.
- Every release would have a link to the last generated Javadoc
(MDT/OCL 3.1.0 Help would have links pointing to the last MDT/OCL
Javadoc)
c) Reintroducing the javadoc into the plugins
- Extra size in doc bundle.
+ Links don't need to be revised every release.
+ Every release will have a link to the corresponding Javadoc
(MDT/OCL 3.1.0 Help would have links pointing to MDT/OCL 3.1.0
Javadoc)
My opinion is:
- The third advantage/disadvantage should not be acceptable (then
b) discarded).
- Giving that the absolute link's URL maybe changed at once with a
simple search & replace, this is not desirable but admissible
.
- The extra size in doc bundles is not desirable but admissible.
The compromise is the extra effort to manual changing the
javadoc-per-release URL (once per release) vs sizes in bundles.
Giving that we actually had to consider to manually change the
references/javadoc/index.html file, I'm inclined to adopt option
a). However, if you prefer any other option, let me know it....
P.S: Axel, re-open the bugzilla with the problem you have
detected... I'll fix the problem as soon as we agree on the
solution.
P.S2: Ed, In the end are we moving the javadoc from downloads to
www area ? I think I'm asking this to Kenn to obtain a third
opinion.
Best Regards,
Adolfo.
El 12/04/2011 13:52, Axel Uhl escribió:
Adolfo,
I installed the nightly build into an Indigo M6. The javadoc
links such as http://127.0.0.1:51730/help/topic/org.eclipse.ocl.doc/references/javadoc/org/eclipse/ocl/examples/eventmanager/EventManager.html
fail to load. To be expected? Shouldn't they refer to the
external documentation? Do I need to adjust the links in the
documentation sources?
Thanks and best,
-- Axel
|
