14017 - doc - add documentation for why parameters must always be enabled

Author: jdaugherty

gradle/java-config.gradle

@@ -34,7 +34,7 @@ tasks.withType(Javadoc).configureEach { Javadoc it ->
 
 tasks.withType(GroovyCompile).configureEach {
     groovyOptions.encoding = 'UTF-8' // encoding needs to be the same since it's different across platforms
-    // Preserve method parameter names in Groovy classes for IDE parameter hints.
+    // Preserve method parameter names in Groovy/Java classes for IDE parameter hints & bean reflection metadata.
     groovyOptions.parameters = true
     options.encoding = 'UTF-8' // encoding needs to be the same since it's different across platforms
     options.fork = true

grails-forge/gradle/java-config.gradle

@@ -27,6 +27,7 @@ extensions.configure(JavaPluginExtension) {
 
 tasks.withType(JavaCompile).configureEach {
     options.encoding = 'UTF-8'
+    // Preserve method parameter names in Java classes for IDE parameter hints & bean reflection metadata.
     options.compilerArgs.add('-parameters')
 }
 

grails-gradle/gradle/java-config.gradle

@@ -48,7 +48,7 @@ tasks.named('sourcesJar', Jar).configure { Jar jar ->
 
 tasks.withType(GroovyCompile).configureEach {
     groovyOptions.encoding = 'UTF-8' // encoding needs to be the same since it's different across platforms
-    // Preserve method parameter names in Groovy classes for IDE parameter hints.
+    // Preserve method parameter names in Groovy/Java classes for IDE parameter hints & bean reflection metadata.
     groovyOptions.parameters = true
     options.encoding = 'UTF-8' // encoding needs to be the same since it's different across platforms
     options.fork = true