[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
|
Re: [platform-dev] How to best document consumed OSGi/DS services?
|
I'm not sure what you have in mind. DO you like to document the *usage*
of DS?
as mentioned earlier I would expects documentation at the service
interface itself. That platform uses DS to consume services is just an
implementation detail and doesn't bother the provider much.
Such documentation then could of course use javadoc annotations that
then could be present in the html output as well see
https://maven.apache.org/plugins-archives/maven-javadoc-plugin-2.8.1/examples/tag-configuration.html
Am 22.03.21 um 13:22 schrieb Mickael Istria:
On Mon, Mar 22, 2021 at 12:28 PM Wim Jongman <wim.jongman@xxxxxxxxx
<mailto:wim.jongman@xxxxxxxxx>> wrote:
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]
That's the kind of things I have in mind too.
To be honest, I would be expecting some other project in OSGi world has
already faced this issue and found/built and standard-ish solution we
could just adopt. Is anyone aware of how other OSGi solutions (eg Karaf,
Kura...) deal with this?
_______________________________________________
platform-dev mailing list
platform-dev@xxxxxxxxxxx
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/platform-dev
