Skip to content

Commit a72f78b

Browse files
committed
updated docs
1 parent d053d90 commit a72f78b

File tree

3 files changed

+12
-6
lines changed

3 files changed

+12
-6
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
/doc_outputs
12
*.iml
23
.idea
34
.temp

haxe-checkstyle/modifierorder.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ override public function close() {}
3838
### Invalid
3939

4040
```java
41-
inline public static var COUNT:Int = 1;\
41+
inline public static var COUNT:Int = 1;
4242
```
4343

4444
{{site.data.alerts.error}} Invalid access modifier order: COUNT (modifier: PUBLIC_PRIVATE) {{site.data.alerts.end}}

haxe-checkstyle/setup.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,6 @@ haxelib run checkstyle -s src -s samples
8484

8585
Classes/Packages can be excluded as shown below for each check:
8686

87-
Note that exclude paths should be relative to the source paths specified.
8887

8988
```json
9089
"exclude": {
@@ -106,6 +105,10 @@ Note that exclude paths should be relative to the source paths specified.
106105
}
107106
```
108107

108+
{{site.data.alerts.note}} Exclude paths should be relative to the source paths specified. {{site.data.alerts.end}}
109+
110+
{{site.data.alerts.tip}} Exclude can either reside in rules JSON file or in a separate JSON file. If separate JSON file is used, it has to be passed using -e option.{{site.data.alerts.end}}
111+
109112
### Suppress Warnings
110113

111114
An alternative way to exclude classes/methods using meta data.
@@ -114,13 +117,13 @@ An alternative way to exclude classes/methods using meta data.
114117

115118
For example, if you have a class which has `Dynamic` usage and you want to omit that class from `Dynamic` check you can use `@SuppressWarnings` as show below.
116119

117-
```
118-
@SuppressWarnings("checkstyle:Dynamic")`
120+
```java
121+
@SuppressWarnings("checkstyle:Dynamic")
119122
```
120123

121124
You can also omit multiple checks.
122125

123-
```
126+
```java
124127
@SuppressWarnings("checkstyle:Dynamic", "checkstyle:LineLength")
125128
```
126129

@@ -132,4 +135,6 @@ Checkstyle has `xml` report option that can be used to integrate with Hudson and
132135

133136
If you want to style the generated XML you can set XSLT style for the XML generated. See the sample below.
134137

135-
`haxelib run checkstyle -s src -c config.json -p report.xml -x report.xsl`
138+
```java
139+
haxelib run checkstyle -s src -c config.json -p report.xml -x report.xsl
140+
```

0 commit comments

Comments
 (0)