Skip to main content

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

I am mostly looking for the specification of the documentation plugin
layout, what extension points it needs to provide, if any, how and where
javadoc needs to be packages, same for examples, documentation and
everything else. I basically need to understand the requirements before
I can suggest anything.

--
Regards,
Igor

On 11-12-18 12:41 PM, Jens v.P. wrote:
On 18.12.11 16:51, Igor Fedorenko wrote:
What is "documentation plugin"? Is there any documentation and/or
examples that explain what should be included in such plugins?

Almost all Eclipse projects provide a single plugin containing the
projects documentation.
It includes the documentation found in the Eclipse help, and usually
also the API documentation, i.e. the JavaDocs.
What I mean with "documentation plugin" are the "*.doc*.jar" bundles you
find in the Eclipse plugin folder.

Meanwhile, I've found bug
https://bugs.eclipse.org/bugs/show_bug.cgi?id=338996 , I figure this is
the "best practice" I've asked for, isn't it?

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


Back to the top