Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [cross-project-issues-dev] Publishing Javadoc - How To?

In efxclipse we are using the "tycho-document-bundle-plugin" plugin to
publish javadoc.

See
http://git.eclipse.org/c/efxclipse/org.eclipse.efxclipse.git/tree/releng/org.eclipse.fx.runtime.doc/pom.xml
- I don't know if this is the best way to do it but at least it works
for us.

Tom

On 26.09.14 14:05, Matthias Sohn wrote:
> On Fri, Sep 26, 2014 at 11:56 AM, Jeremie Bresson
> <Jeremie.Bresson@xxxxxxxxx <mailto:Jeremie.Bresson@xxxxxxxxx>> wrote:
> 
>     Hi Everybody,____
> 
>     __ __
> 
>     Since a very long time people are asking us to publish the Javadoc
>     of the Eclipse Scout Project as HTML page [Bug 408052 - #1].____
> 
>     __ __
> 
>     I wonder what the best practice is. I have seen that some project
>     have decided to publish it under:____
> 
>     * help.eclipse.org <http://help.eclipse.org> (for example the SWT
>     project [#2])____
> 
>     * download.eclipse.org <http://download.eclipse.org> (for example
>     the EMF project [#3])____
> 
>     __ __
> 
>     Personally I like the second approach. Is there an official
>     recommended approach?____
> 
>     __ __
> 
>     Could you also indicate how to achieve this during a CBI build? ____
> 
>     We are using maven tycho. I imagine there are examples in the
>     projects that are already publishing Javadoc. I would really
>     appreciate a pointer to know how to start.____
> 
>     __ __
> 
>     Thank you in advance,____
> 
>     Jérémie____
> 
>     [#1] https://bugs.eclipse.org/bugs/show_bug.cgi?id=408052____
> 
>     [#2]
>     http://help.eclipse.org/luna/topic/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/package-summary.html
>     ____
> 
>     [#3] http://download.eclipse.org/modeling/emf/emf/javadoc/2.9.0/
> 
> 
> I just implemented the second approach for JGit using maven-site-plugin,
> the changes implementing
> that are here:
> https://git.eclipse.org/r/#/c/33891/
> https://git.eclipse.org/r/#/c/33892/
> and the first result is here (javadoc is under project reports)
> http://download.eclipse.org/jgit/site/3.5.0-SNAPSHOT/ 
> 
> --
> Matthias
> 
> 
> _______________________________________________
> cross-project-issues-dev mailing list
> cross-project-issues-dev@xxxxxxxxxxx
> To change your delivery options, retrieve your password, or unsubscribe from this list, visit
> https://dev.eclipse.org/mailman/listinfo/cross-project-issues-dev
> 



Back to the top