saad120 / dkpro-wsd

Automatically exported from code.google.com/p/dkpro-wsd
0 stars 0 forks source link

Use uimafit-maven-plugin to fill in ConfigurationParameter descriptions #69

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago
The following suggestion comes from Richard:

=== description in ConfigurationParameter ===

<pre>
    public static final String PARAM_SENSE_INVENTORY = "senseInventory";
    @ConfigurationParameter(name = PARAM_SENSE_INVENTORY, mandatory = false, description = "The sense inventory used by the answer key", defaultValue = "WordNet_3.0_sensekey")
    private String senseInventory;
</pre>

The description should be in JavaDoc so that the user can also get
it along with code completion in Eclipse and so that it ends up in
the API docs.

<pre>
    /**
     * The sense inventory used by the answer key
     */
    public static final String PARAM_SENSE_INVENTORY = "senseInventory";
    @ConfigurationParameter(name = PARAM_SENSE_INVENTORY, mandatory = false, defaultValue = "WordNet_3.0_sensekey")
    private String senseInventory;
</pre>

Use the uimafit-maven-plugin to automatically fill in the "description"
argument of the ConfigurationParameter from the JavaDoc:

<pre>
        <plugins>
            <plugin>
                <groupId>org.apache.uima</groupId>
                <artifactId>uimafit-maven-plugin</artifactId>
            </plugin>
        </plugins>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.apache.uima</groupId>
                    <artifactId>uimafit-maven-plugin</artifactId>
                    <version>${uimafit.version}</version>
                    <configuration>
                        <componentVendor>DKPro Core Project</componentVendor>
                        <componentCopyright>
                            Copyright 2010
                            Ubiquitous Knowledge Processing (UKP) Lab
                            Technische Universität Darmstadt
                        </componentCopyright>
                        <failOnMissingMetaData>false</failOnMissingMetaData>
                    </configuration>
                    <executions>
                        <execution>
                            <id>default</id>
                            <phase>process-classes</phase>
                            <goals>
                                <goal>enhance</goal>
                                <goal>generate</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>
            </plugins>
        </pluginManagement>
</pre>

Original issue reported on code.google.com by tristan.miller@nothingisreal.com on 9 Jan 2015 at 1:54