Re: [ease-dev] Link to Help in Module Explorer

[Geneviève Bastien <gbastien+lttng@xxxxxxxxxxxx>]

Hi Christian,

I was able to manually generate the help, though there appear to be some
bug with {@link } statements to methods that receive a generic, it puts
'<' characters in the URL. I'll look into it a bit more later.

Thanks for the info, I'll try to generate it automatically next.

Geneviève


On 10/2/19 4:45 PM, Christian Pontesegger wrote:
> Hi Geneviève,
>
>> But our own modules do not display help. Do we need to do anything
>> specific? We have javadoc, our javadoc is generated and published on
>> a
>> web site. I saw in the ModuleDefinition class that it looks for
>> something in / + getBundleId(), etc. How do we get our doc available
>> there?
> We do provide a dedicated doclet that allows to reuse the javadoc
> generator to create these help files.
>
> A static example how to do this is available on my blog:
> http://codeandme.blogspot.com/2014/10/writing-modules-for-ease.html
> (at the very end of this post).
>
> The doclet is available in source:
> https://git.eclipse.org/c/ease/org.eclipse.ease.core.git/tree/developers/org.eclipse.ease.helpgenerator
> or as a binary on jenkins:
> https://ci.eclipse.org/ease/job/ease.build.module.doclet/
>
> The documentation step can also be integrated into a tycho build as we
> do it for our modules. Our build pom shows how to do this:
> https://git.eclipse.org/c/ease/org.eclipse.ease.modules.git/tree/releng/org.eclipse.ease.modules.releng/pom.xml
> (check out the module.docs profile inside the pom)
>
> HTH
> Christian
>
>
>
>
> _______________________________________________
> ease-dev mailing list
> ease-dev@xxxxxxxxxxx
> To change your delivery options, retrieve your password, or unsubscribe from this list, visit
> https://www.eclipse.org/mailman/listinfo/ease-dev