At a minimum the interface which can be registered as a whiteboard service should have its javadoc updated to indicate the interface is intended for implementers to register their implementations as OSGi services. Any constants that are required in the service registration properties should also have javadoc available to describe the property and its expected value type.
The documentation for the extension point could also give a hint that the extension interface type can alternatively be registered as an OSGi service. For org.eclipse.core.runtime.IAdapterFactory we did document the service property key constants, but it looks like the main javadoc for class does not give the hint that implementations of the interface can be registered as an OSGi service.
Tom
----- Original message -----
From: "Christoph Läubrich" <laeubi@xxxxxxxxxxxxxx>
Sent by: "platform-dev" <platform-dev-bounces@xxxxxxxxxxx>
To: platform-dev@xxxxxxxxxxx
Cc:
Subject: [EXTERNAL] Re: [platform-dev] How to document OSGi extensibility?
Date: Fri, Jan 22, 2021 7:54 AM
One way would be to document this at the package-info.java
Maybe it would be worth to have a special annotation that could be
parsed by eclipse and give a hint to the user when a extensionpoint is
used that also supports OSGi services?
another option would be to annotate an interface with a custom
annotation e.g.
@Whiteboard({"org.eclipse.ui.genericeditor.contentAssistProcessors",
"whatever else"})
interface IContentAssistProcessors {
}
of course the list would only be a hint and not meant to be complete...
Am 22.01.21 um 14:08 schrieb Mickael Istria:
> Hi all,
>
> In a recent patch, the Generic Editor was improved to enable consumption
> of IContentAssistProcessors in the OSGi way (that is by listening to
> service tracker).
> While we have great ways to document extenson via plugin.xml, do we have
> a recommendation about how to document such extensibility strategies?
> Where should it be described that Generic Editor receives such extension
> (beyond the Javadoc, especially since it's internal code)?
> Thanks in advance
>
> --
> Mickael Istria
> Eclipse IDE <https://www.eclipse.org/downloads/eclipse-packages/>
> developer, for Red Hat Developers <https://developers.redhat.com/ >
>
> _______________________________________________
> platform-dev mailing list
> platform-dev@xxxxxxxxxxx
> To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/platform-dev
>
_______________________________________________
platform-dev mailing list
platform-dev@xxxxxxxxxxx
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/platform-dev
