search

spotify / docker-maven-plugin

INACTIVE: A maven plugin for Docker
Apache License 2.0
2.67k stars 575 forks source link

Add documentation for configuration properties that IDE tooling can see #265

Closed davidmichaelkarr closed 8 years ago

davidmichaelkarr commented 8 years ago

Typically, Maven plugins are built to work with IDEs (Eclipse, for instance) such that if I add the "" block to the plugin and then enter "<", I can step through the allowed configuration properties and see the tooltip that describes the configuration property. Presently, what shows for all of the properties for this plugin just has the name and the type.

mattnworb commented 8 years ago

I am not sure how Eclipse derives that info, but it works already for IntelliJ:

image

I would hope that any IDE would base it's auto-complete / documentation on the javadoc comments for @Parameter-annotated methods - as I believe the Maven build process generates a META-INF/maven/plugin.xml that is included in the JAR for the plugin.

If you find that Eclipse needs some other sort of metadata about the plugin I'd be happy to merge a PR that adds whatever Eclipse-specific info is needed.