On Fri, Jan 22, 2021 at 3:42 PM Christoph Läubrich <lae...@laeubi-soft.de>
wrote:
> Good point! I'd like to enhance my annotation idea in the following way:
>
> @Whiteboard(extensions = {
> "org.eclipse.ui.genericeditor.contentAssistProcessors"
> }
> properties = {"xyz"}
> }
> )
>
> that way it would be possible to automatically read the meta-data and
> transform them into help or whatever...
Eclipse Platform should avoid the funk of building and relying on
Eclipse-specific documentation annotations for OSGi. It looks like in this
case, it's more interesting to just bring the idea to the OSGi Alliance so
it can become specified or shared with other OSGi projects to identify the
best solution in a standard-ish way; and then Eclipse Platform could start
using them.
Concretely, generating documentation is a difficult task, see how javadoc
or PDE extension point doc-gen are complex; we don't want to start dealing
with such extra complex new problem in Platform.
Note that 1 issue introduced by the idea of documenting on the interface is
that it kinds of break the layers: the IContentAssistProcessor interface is
not aware of Generic Editor, so it looks like we'd suddenly have to make it
kind of aware of it, at least in the doc, creating a (very soft, not
technically binding) dependency cycle. That seems undesired to me.
_______________________________________________
platform-dev mailing list
platform-dev@eclipse.org
To unsubscribe from this list, visit
https://www.eclipse.org/mailman/listinfo/platform-dev
