Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [tycho-user] javadoc - best practices

What is "documentation plugin"? Is there any documentation and/or
examples that explain what should be included in such plugins?

--
Regards,
Igor

On 11-12-17 12:10 PM, Jens v.P. wrote:
Hi all,

I'm currently setting up a Tycho based build system for GEF3D. First of
all: Tycho is really great! The build script is already creating all
plugins, features, and the update site / p2 repository.

Now I'm wondering how to best set up the build for the documentation
plugin, including the JavaDocs. I have looked at some other Eclipse
projects, and it seems as if there is no best way -- I've found a lot of
individual ant scripts. While I also have my special ant script, I'm not
that happy with it (because it creates the Javadoc directly in the
plugin folder and not in a target folder).

Basically -- and I would assume this is a standard requirement -- I need
JavaDoc for all plugins for which I have created source plugins (with
tycho-source-plugin). Since I only want to provide a single
documentation plugin, I'd like to somehow "merge" the javadocs with the
other (html) documents contained in my doc plugin.

Is there a "Tycho way" of doing that?

Cheers,
Jens
_______________________________________________
tycho-user mailing list
tycho-user@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/tycho-user


Back to the top