From 8a65d2ff82f04e50b9a5bc37408b594aeeeae5af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20K=C3=BChne?= Date: Sun, 8 Sep 2002 12:55:14 +0000 Subject: [PATCH] docs for package name check --- docs/config_naming.html | 22 ++++++++++++++++++++++ docs/releasenotes.html | 3 ++- 2 files changed, 24 insertions(+), 1 deletion(-) diff --git a/docs/config_naming.html b/docs/config_naming.html index cb519cbca..e4de6c7b0 100644 --- a/docs/config_naming.html +++ b/docs/config_naming.html @@ -85,6 +85,28 @@ specifies the format for parameter names. The property type is ^[a-z][a-zA-Z0-9]*$.

+

Format of package names

+ +

The property checkstyle.pattern.package specifies +the format for class and interface names. The property type is +regular expression and defaults to +^[a-z]+(\.[a-zA-Z_][a-zA-Z_0-9]*)*$.

+ +
+

Tip

+ +

+The default value of checkstyle.pattern.package +has been chosen to match the requirements in the + +Java Language specification and the Sun coding conventions. +However both underscores and uppercase letters are rather uncommon, so most projects +should probably use +checkstyle.pattern.package=^[a-z]+(\.[a-z][a-z0-9]*)*$ +

+
+ +

Format of type names

The property checkstyle.pattern.type specifies diff --git a/docs/releasenotes.html b/docs/releasenotes.html index 344262204..bd0eab990 100644 --- a/docs/releasenotes.html +++ b/docs/releasenotes.html @@ -43,8 +43,9 @@ New features: