diff --git a/docs/engine.html b/docs/engine.html index 771f2c710..dab9680db 100644 --- a/docs/engine.html +++ b/docs/engine.html @@ -93,6 +93,56 @@ +

Curly Braces

+

Checks for the correct placement of left curly braces '{'. The check can be configured with the following options:

+ + + + + + + + + + + + + + + + + + + + +
OptionDefinition
ignoreIgnore the placement of the brace.
nlThe brace must always be on a new line. For example: +
+    if (condition)
+    {
+        ...
+
+
eolThe brace must always be on the end of the line. For example: +
+    if (condition) {
+        ...
+
+ This is the default value. +
nlowIf the brace will fit on the first line of the statement, taking into account making line length, then apply eol rule. Otherwise apply the nl rule. nlow is a mnemonic for "new line on wrap". For the example above Checkstyle will enforce: +
+    if (condition) {
+        ...
+
+ But for a statement spanning multiple lines, Checkstyle will enforce: +
+    if (condition1 && condition2 &&
+        condition3 && condition4)
+    {
+        ...
+
+ +
+ +

Long Lines

Checks for lines that are longer than a specified length. The default is "80". This can be turned off for import statements.