aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrei Selkin <andreyselkin@gmail.com>2015-12-09 20:54:21 +0300
committerAndrei Selkin <andreyselkin@gmail.com>2015-12-09 20:56:39 +0300
commit5d7226fac58883bc41058b28b8fcdb6f159cf1e2 (patch)
tree15bcb71eb8e45f14b8ca15486d6e6bcc65330f8b
parentd33b0901fb8241923613185bb9702200731f6e28 (diff)
downloadcheckstyle-5d7226fac58883bc41058b28b8fcdb6f159cf1e2.tar.gz
doc: Add example for ParameterName into xdoc
-rw-r--r--src/xdocs/config_naming.xml9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/xdocs/config_naming.xml b/src/xdocs/config_naming.xml
index 0dbda1e34..9651d4fda 100644
--- a/src/xdocs/config_naming.xml
+++ b/src/xdocs/config_naming.xml
@@ -1034,6 +1034,15 @@ public boolean equals(Object o) {
&lt;property name="ignoreOverridden" value="true"/&gt;
&lt;/module&gt;
</source>
+ <p>
+ An example of how to configure the check for names that begin with
+ a lower case letter, followed by letters and digits is:
+ </p>
+ <source>
+&lt;module name="ParameterName"&gt;
+ &lt;property name="format" value="^[a-z][a-zA-Z0-9]+$"/&gt;
+&lt;/module&gt;
+ </source>
</subsection>
<subsection name="Example of Usage">