[TINKERPOP-1165] Tooling Support: Compile with -parameters

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Done
• Affects Version/s: 3.1.1-incubating
• Fix Version/s: 3.2.0-incubating, 3.1.2-incubating
• Component/s: build-release
• Assignee: Stephen Mallette
• Reporter: Zachary Kurey
• Created: 18/Feb/16 03:26
• Updated: 23/Feb/16 15:58
• Resolved: 23/Feb/16 15:58

Description

For tools that provide content assist of parameter names for methods, it would be good to have parameter names retained within the compiled class files. There may be a good reason I can't think of not to enable this, but enabling it is as simple as adding -parameters to the maven compile plugin configuration:

            <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-compiler-plugin</artifactId>
                    <version>3.1</version>
                    <configuration>
                        <source>1.8</source>
                        <target>1.8</target>
                        <compilerArgs>
                                <arg>-parameters</arg> 
                        </compilerArgs>
                    </configuration>
                </plugin>

In the root pom.xml of the project.

Of course there are other ways to go about this processing the sources or javadoc(provided every public method is very well documented), but this is the simplest way to expose the meaningful param names to tooling.