aboutsummaryrefslogtreecommitdiffstats
path: root/checkstyle.cfg
blob: 9edb4b5be525a5abeb3d71327cda87bec9a6e377 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# $Id$

# Checkstyle configuration for the Apache FOP project.
# See http://xml.apache.org/fop for information about FOP.
# The entries here are sorted in the order of the Checkstyle 2.4 documentation
# for easier reference.

# Javadoc Comments
checkstyle.javadoc.scope = protected
checkstyle.require.packagehtml = false
checkstyle.require.version = false
checkstyle.allow.noauthor = yes
checkstyle.javadoc.checkUnusedThrows = false

# Naming Conventions
# non-static members
checkstyle.pattern.member = ^[a-z][a-zA-Z0-9]*$
# non-static, public members
checkstyle.pattern.publicmember = ^[a-z][a-zA-Z0-9]*$
# constants (static & final)
checkstyle.pattern.const = ^[A-Z](_?[A-Z0-9]+)*$
# other static
checkstyle.pattern.static = ^[a-z][a-zA-Z0-9]*$
# method parameters
checkstyle.pattern.parameter = ^[a-z][a-zA-Z0-9]*$
# packages
checkstyle.pattern.package = ^[a-z]+(\.[a-zA-Z_][a-zA-Z_0-9]*)*$
# classes and interfaces
checkstyle.pattern.type = ^[A-Z][a-zA-Z0-9]*$
# methods
checkstyle.pattern.method = ^[a-z][a-zA-Z0-9]*$
# local variables
checkstyle.pattern.localvar = ^[a-z][a-zA-Z0-9]*$
# final local variables
checkstyle.pattern.localfinalvar = ^[a-z][a-zA-Z0-9]*$

# Headers
checkstyle.header.file = checkstyle.header
checkstyle.header.ignoreline
checkstyle.header.regexp = yes

# Imports
checkstyle.ignore.imports = false
checkstyle.illegal.imports = sun

# Size Violations
checkstyle.maxlinelen = 100
checkstyle.tab.width = 4
checkstyle.ignore.importlength = yes
checkstyle.ignore.maxlinelen = ^$
checkstyle.maxmethodlen = 150
checkstyle.maxconstructorlen = 150
checkstyle.maxfilelen = 2000
checkstyle.maxparameters = 7

# Whitespace
checkstyle.allow.tabs = no
checkstyle.ignore.whitespace = false
checkstyle.ignore.whitespace.cast = yes
checkstyle.paren.pad = nospace
checkstyle.wrap.operator = nl

# Modifiers
checkstyle.ignore.public.in.interface = false
checkstyle.allow.protected = yes
checkstyle.allow.package = false
# Note -- checkstyle.pattern.publicmember is documented in this location
#   in the checkstyle documentation. However, it is also included in the "Naming
#   Conventions" section above. Please do not add it here, as having two in the
#   file will result in changes to only one being ignored (checkstyle appears to
#   use the last definition).

# Blocks
checkstyle.ignore.braces = false
checkstyle.block.try = stmt
checkstyle.block.catch = text
checkstyle.block.finally = stmt
checkstyle.lcurly.type = eol
checkstyle.lcurly.method = eol
checkstyle.lcurly.other = eol
checkstyle.rcurly = same

# Miscellaneous Checks
checkstyle.pattern.todo = TODO:
checkstyle.ignore.longell = false
checkstyle.illegal.instantiations =

# Last Line of $RCSfile$