Re: [platform-dev] How to best document consumed OSGi/DS services?

[Wim Jongman <wim.jongman@xxxxxxxxx>]

Just brainstorming I would say, extend the javadoc engine to process the service xml with some style sheet and insert that in the HTML output?

Does anyone know if Javadoc can be extended like that? The doc on javadoc suggest the usage of an extension mechanism [1]

Cheers, Wim

[1] https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.htm

On Sat, Mar 20, 2021 at 6:38 PM Mickael Istria <mistria@xxxxxxxxxx> wrote:

Hi all,

I see more and more usage of OSGi DS in Platform code. That's a good thing as it brings more lazy-loading and more dynamism.

One thing we need to improve on that topic is how we should document the services that are consumed by Platform? Ideally, it should be something as convenient and well-defined as the extension point description; with proper generation in the Eclipse help.

Does someone has further or more advanced idea on how we can concretely implement this?

Cheers

--

Mickael Istria

Eclipse IDE developer, for Red Hat Developers

_______________________________________________
platform-dev mailing list
platform-dev@xxxxxxxxxxx
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/platform-dev