Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pmd-bot committed Aug 13, 2017
1 parent 4c255cb commit 52d78d2
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 14 deletions.
16 changes: 6 additions & 10 deletions docs/pages/pmd/rules/apex/braces.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,9 @@ indentation is lost then it becomes difficult to separate the code being control
from the rest.

```
//ForLoopStatement
[child::ExpressionStatement]
//ForLoopStatement/BlockStatement[@CurlyBrace='false']
|
//ForEachStatement
[child::ExpressionStatement]
//ForEachStatement/BlockStatement[@CurlyBrace='false']
```

**Example(s):**
Expand Down Expand Up @@ -54,11 +52,9 @@ or indentation is lost then it becomes difficult to separate the code being cont
from the rest.

```
//ExpressionStatement[parent::IfBlockStatement]
//IfBlockStatement/BlockStatement[@CurlyBrace='false'][count(child::*) > 0]
|
//ExpressionStatement[parent::IfElseBlockStatement]
|
//IfElseBlockStatement[parent::IfBlockStatement]
//IfElseBlockStatement/BlockStatement[@CurlyBrace='false'][count(child::*) > 0]
```

**Example(s):**
Expand Down Expand Up @@ -93,7 +89,7 @@ formatting or indentation is lost then it becomes difficult to separate the code
controlled from the rest.

```
//IfBlockStatement/ExpressionStatement
//IfBlockStatement/BlockStatement[@CurlyBrace='false']
```

**Example(s):**
Expand Down Expand Up @@ -126,7 +122,7 @@ formatting or indentation is lost then it becomes difficult to separate the code
controlled from the rest.

```
//WhileLoopStatement/ExpressionStatement
//WhileLoopStatement/BlockStatement[@CurlyBrace='false']
```

**Example(s):**
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/pmd/rules/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ List of rulesets and rules contained in each ruleset.

## Comments
* [CommentContent](pmd_rules_java_comments.html#commentcontent): A rule for the politically correct... we don't want to offend anyone.
* [CommentDefaultAccessModifier](pmd_rules_java_comments.html#commentdefaultaccessmodifier): To avoid mistakes if we want that a Method, Field or Nested class have a default access modifier ...
* [CommentDefaultAccessModifier](pmd_rules_java_comments.html#commentdefaultaccessmodifier): To avoid mistakes if we want that a Method, Constructor, Field or Nested class have a default acc...
* [CommentRequired](pmd_rules_java_comments.html#commentrequired): Denotes whether comments are required (or unwanted) for specific language elements.
* [CommentSize](pmd_rules_java_comments.html#commentsize): Determines whether the dimensions of non-header comments found are within the specified limits.

Expand Down
6 changes: 3 additions & 3 deletions docs/pages/pmd/rules/java/comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ A rule for the politically correct... we don't want to offend anyone.

**Priority:** Medium (3)

To avoid mistakes if we want that a Method, Field or Nested class have a default access modifier
we must add a comment at the beginning of the Method, Field or Nested class.
By default the comment must be /* default */, if you want another, you have to provide a regex.
To avoid mistakes if we want that a Method, Constructor, Field or Nested class have a default access modifier
we must add a comment at the beginning of it's declaration.
By default the comment must be /* default */, if you want another, you have to provide a regexp.

**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.java.rule.comments.CommentDefaultAccessModifierRule](https://github.com/pmd/pmd/blob/master/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/comments/CommentDefaultAccessModifierRule.java)

Expand Down

0 comments on commit 52d78d2

Please sign in to comment.