Skip to content

Commit f3f17ba

Browse files
keilwkeilw
committed
6: Reduce JavaDoc warnings/errors
Task-Url: https://github.com/unitsofmeasurement/unit-tck/issues/issues/6
1 parent ad19ea7 commit f3f17ba

31 files changed

Lines changed: 1205 additions & 565 deletions

‎.editorconfig‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,33 @@
1+
#
2+
# Units of Measurement TCK
3+
# Copyright © 2005-2017, Jean-Marie Dautelle, Werner Keil, V2COM.
4+
#
5+
# All rights reserved.
6+
#
7+
# Redistribution and use in source and binary forms, with or without modification,
8+
# are permitted provided that the following conditions are met:
9+
#
10+
# 1. Redistributions of source code must retain the above copyright notice,
11+
# this list of conditions and the following disclaimer.
12+
#
13+
# 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions
14+
# and the following disclaimer in the documentation and/or other materials provided with the distribution.
15+
#
16+
# 3. Neither the name of JSR-363 nor the names of its contributors may be used to endorse or promote products
17+
# derived from this software without specific prior written permission.
18+
#
19+
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20+
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
21+
# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22+
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
23+
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24+
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25+
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26+
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27+
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
28+
# EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29+
#
30+
131
# Configuration file for EditorConfig: http://editorconfig.org
232
root = true
333

‎LICENSE.txt‎

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,31 @@
1-
Unit-API - Units of Measurement API for Java
2-
Copyright (c) 2005-2016, Jean-Marie Dautelle, Werner Keil, V2COM.
3-
4-
All rights reserved.
1+
====
2+
Units of Measurement TCK
3+
Copyright © 2005-2017, Jean-Marie Dautelle, Werner Keil, V2COM.
54

6-
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
5+
All rights reserved.
76

8-
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
7+
Redistribution and use in source and binary forms, with or without modification,
8+
are permitted provided that the following conditions are met:
99

10-
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
10+
1. Redistributions of source code must retain the above copyright notice,
11+
this list of conditions and the following disclaimer.
1112

12-
3. Neither the name of JSR-363 nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
13+
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions
14+
and the following disclaimer in the documentation and/or other materials provided with the distribution.
1315

14-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
15-
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
16-
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17-
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
18-
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19-
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20-
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
21-
AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22-
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
23-
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
16+
3. Neither the name of JSR-363 nor the names of its contributors may be used to endorse or promote products
17+
derived from this software without specific prior written permission.
18+
19+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
21+
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22+
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
23+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26+
AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
28+
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29+
====
30+
31+
====

‎circle.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,33 @@
1+
#
2+
# Units of Measurement TCK
3+
# Copyright © 2005-2017, Jean-Marie Dautelle, Werner Keil, V2COM.
4+
#
5+
# All rights reserved.
6+
#
7+
# Redistribution and use in source and binary forms, with or without modification,
8+
# are permitted provided that the following conditions are met:
9+
#
10+
# 1. Redistributions of source code must retain the above copyright notice,
11+
# this list of conditions and the following disclaimer.
12+
#
13+
# 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions
14+
# and the following disclaimer in the documentation and/or other materials provided with the distribution.
15+
#
16+
# 3. Neither the name of JSR-363 nor the names of its contributors may be used to endorse or promote products
17+
# derived from this software without specific prior written permission.
18+
#
19+
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20+
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
21+
# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22+
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
23+
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24+
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25+
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26+
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27+
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
28+
# EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29+
#
30+
131
test:
232
override:
333
- mvn install

‎src/main/config/checkstyle.xml‎

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
4+
Unit-API - Units of Measurement API for Java
5+
Copyright (c) 2005-2014, Jean-Marie Dautelle, Werner Keil, V2COM.
6+
7+
All rights reserved.
8+
9+
Redistribution and use in source and binary forms, with or without modification,
10+
are permitted provided that the following conditions are met:
11+
12+
1. Redistributions of source code must retain the above copyright notice,
13+
this list of conditions and the following disclaimer.
14+
15+
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions
16+
and the following disclaimer in the documentation and/or other materials provided with the distribution.
17+
18+
3. Neither the name of JSR-363 nor the names of its contributors may be used to endorse or promote products
19+
derived from this software without specific prior written permission.
20+
21+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
23+
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24+
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28+
AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30+
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31+
32+
-->
33+
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
34+
35+
<!--
36+
This configuration file was written by the eclipse-cs plugin configuration editor
37+
-->
38+
<!--
39+
Checkstyle-Configuration: Unit-API
40+
Description: none
41+
-->
42+
<module name="Checker">
43+
<property name="severity" value="warning"/>
44+
<module name="TreeWalker">
45+
<property name="tabWidth" value="4"/>
46+
<module name="FileContentsHolder"/>
47+
<module name="ConstantName">
48+
<property name="format" value="^[A-Z_][A-Z0-9]*(_[A-Z0-9]+)*$"/>
49+
</module>
50+
<module name="AvoidStarImport"/>
51+
<module name="EmptyBlock">
52+
<property name="tokens" value="LITERAL_DO,LITERAL_ELSE,LITERAL_FINALLY,LITERAL_IF,LITERAL_TRY,LITERAL_WHILE,STATIC_INIT"/>
53+
</module>
54+
<module name="EmptyForInitializerPad">
55+
<property name="option" value="space"/>
56+
</module>
57+
<module name="EmptyForIteratorPad">
58+
<property name="option" value="space"/>
59+
</module>
60+
<module name="EqualsHashCode"/>
61+
<module name="IllegalImport"/>
62+
<module name="IllegalInstantiation"/>
63+
<module name="JavadocType">
64+
</module>
65+
<module name="JavadocMethod">
66+
<property name="scope" value="package"/>
67+
<property name="excludeScope" value="anoninner"/>
68+
<property name="allowUndeclaredRTE" value="true"/>
69+
</module>
70+
<module name="JavadocVariable">
71+
<property name="excludeScope" value="anoninner"/>
72+
</module>
73+
<module name="LeftCurly"/>
74+
<module name="LineLength">
75+
<property name="ignorePattern" value="^ *\* *[^ ]+$"/>
76+
<property name="max" value="200"/>
77+
</module>
78+
<module name="LocalFinalVariableName"/>
79+
<module name="LocalVariableName"/>
80+
<module name="MemberName"/>
81+
<module name="MethodLength">
82+
<property name="max" value="250"/>
83+
</module>
84+
<module name="MethodName"/>
85+
<module name="ModifierOrder"/>
86+
<module name="NeedBraces">
87+
<property name="tokens" value="LITERAL_DO,LITERAL_ELSE,LITERAL_IF,LITERAL_WHILE"/>
88+
</module>
89+
<module name="NoWhitespaceAfter"/>
90+
<module name="NoWhitespaceBefore">
91+
<property name="allowLineBreaks" value="true"/>
92+
<property name="tokens" value="DOT"/>
93+
</module>
94+
<module name="OperatorWrap">
95+
<property name="option" value="eol"/>
96+
<property name="tokens" value="ASSIGN, DIV_ASSIGN, PLUS_ASSIGN, MINUS_ASSIGN, STAR_ASSIGN, MOD_ASSIGN, SR_ASSIGN, BSR_ASSIGN, SL_ASSIGN, BXOR_ASSIGN, BOR_ASSIGN, BAND_ASSIGN"/>
97+
</module>
98+
<module name="PackageName"/>
99+
<module name="ParameterName"/>
100+
<module name="ParameterNumber">
101+
<property name="max" value="20"/>
102+
</module>
103+
<module name="ParenPad"/>
104+
<module name="RedundantImport"/>
105+
<module name="RedundantModifier"/>
106+
<module name="RightCurly"/>
107+
<module name="SimplifyBooleanReturn"/>
108+
<module name="StaticVariableName"/>
109+
<module name="TypeName"/>
110+
<module name="TypecastParenPad"/>
111+
<module name="UpperEll"/>
112+
<module name="VisibilityModifier">
113+
<property name="packageAllowed" value="true"/>
114+
</module>
115+
<module name="WhitespaceAfter"/>
116+
<module name="WhitespaceAround">
117+
<property name="tokens" value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, EQUAL, GE, GT, LAND, LCURLY, LE, LITERAL_ASSERT, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN"/>
118+
</module>
119+
<module name="AnnotationUseStyle"/>
120+
<module name="MissingDeprecated"/>
121+
<module name="PackageAnnotation"/>
122+
<module name="SuppressWarnings"/>
123+
<module name="JavadocStyle"/>
124+
<module name="ClassTypeParameterName"/>
125+
<module name="MethodTypeParameterName"/>
126+
<module name="ImportOrder">
127+
<property name="option" value="top" />
128+
</module>
129+
<module name="GenericWhitespace"/>
130+
<module name="MethodParamPad"/>
131+
<module name="CovariantEquals"/>
132+
<module name="DefaultComesLast"/>
133+
<module name="ExplicitInitialization"/>
134+
<module name="FallThrough"/>
135+
<module name="JUnitTestCase"/>
136+
<module name="FinalClass"/>
137+
<module name="HideUtilityClassConstructor"/>
138+
<module name="InterfaceIsType"/>
139+
<module name="MutableException"/>
140+
<module name="ArrayTypeStyle"/>
141+
</module>
142+
<!-- module name="SuppressionFilter">
143+
<property name="file" value="${basedir}/suppressions.xml"/>
144+
</module -->
145+
<module name="SuppressionCommentFilter">
146+
<property name="offCommentFormat" value="CSOFF\: ([\w\|]+)"/>
147+
<property name="onCommentFormat" value="CSON\: ([\w\|]+)"/>
148+
<property name="checkFormat" value="$1"/>
149+
</module>
150+
<module name="FileLength">
151+
<property name="max" value="3000"/>
152+
</module>
153+
<module name="JavadocPackage">
154+
<property name="allowLegacy" value="true" />
155+
</module>
156+
<module name="FileTabCharacter"/>
157+
</module>

0 commit comments

Comments
 (0)