How to expose @ConfigurationParameter metadata in Eclipse tooltips

[Tristan Miller]

Greetings.

uimaFIT defines the @ConfigurationParameter annotation which annotates
the fields of analysis engines and collection readers. It declares some
very important metadata such as the default value and description. Is
there any way of getting Eclipse to display this metadata in a tooltip,
the same way it exposes documentation for other Java objects on
mouseover or keyboard completion?

Regards,
Tristan

--
Tristan Miller, Doctoral Researcher
Ubiquitous Knowledge Processing Lab (UKP-TUDA)
Department of Computer Science, Technische Universität Darmstadt
Tel: +49 6151 16 6166 | Web: http://www.ukp.tu-darmstadt.de/

[Richard Eckart de Castilho]

Hi,

not short of writing an Eclipse plugin, in particular since Eclipse can read the JavaDoc directly from the source code. I'd recommend repeating the information in the JavaDoc comment of the public static final PARAM_XXX variable.

I personally wouldn't recommend using the description field. uimaFIT 2.0 will come with a Maven plugin which automatically extracts the description from the JavaDoc and adds it to the annotation in the compiled class.

See also:

- https://issues.apache.org/jira/browse/UIMA-2553
- https://issues.apache.org/jira/browse/UIMA-2599

-- Richard