| Re: [ease-dev] Link to Help in Module Explorer |
> 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.
>
I doubt that wrapped methods using generics do any good. As the type
information gets removed during compile time, it does not exist anymore
when the the script language accesses your class. I would recommend to
remove parameters/return types using generics.
However if the documentation generator creates invalid xml code, this
of course needs to be fixed. Please open a bug and provide a simple
sample module that shows the problem.
For links within the script module use @module instead of @link. It
uses the same syntax, but its not documented anywhere. Check out
https://git.eclipse.org/c/ease/org.eclipse.ease.modules.git/tree/plugins/org.eclipse.ease.modules.platform/src/org/eclipse/ease/modules/platform/ResourcesModule.java
for some example usage
Christian