Skip to content

Commit 76412ed

Browse files
author
Yoshito Umaoka
committed
Fixed javadoc errors/warnings and updated Eclipse project files settings
- Updated java doc comment to resolve all errors/warnings reported by >mvn javadoc:javadoc - Eclipse project setting to include ths standard code style preferences. - Cleaned up pom.xml, correct indents and use updated the dependency to use gp-res-filter snapshot.
1 parent efd89f9 commit 76412ed

8 files changed

Lines changed: 383 additions & 80 deletions

File tree

‎gp-ant-task/.classpath‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,6 @@
66
<attribute name="maven.pomderived" value="true"/>
77
</attributes>
88
</classpathentry>
9-
<classpathentry kind="src" output="target/test-classes" path="src/test/java">
10-
<attributes>
11-
<attribute name="optional" value="true"/>
12-
<attribute name="maven.pomderived" value="true"/>
13-
</attributes>
14-
</classpathentry>
159
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.7">
1610
<attributes>
1711
<attribute name="maven.pomderived" value="true"/>

‎gp-ant-task/.settings/org.eclipse.jdt.core.prefs‎

Lines changed: 303 additions & 0 deletions
Large diffs are not rendered by default.

‎gp-ant-task/.settings/org.eclipse.jdt.ui.prefs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
eclipse.preferences.version=1
2+
formatter_profile=_gaas
3+
formatter_settings_version=12
4+
org.eclipse.jdt.ui.javadoc=false
5+
org.eclipse.jdt.ui.text.custom_code_templates=<?xml version\="1.0" encoding\="UTF-8"?><templates><template autoinsert\="true" context\="gettercomment_context" deleted\="false" description\="Comment for getter method" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name\="gettercomment">/**\r\n * @return the ${bare_field_name}\r\n */</template><template autoinsert\="true" context\="settercomment_context" deleted\="false" description\="Comment for setter method" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.settercomment" name\="settercomment">/**\r\n * @param ${param} the ${bare_field_name} to set\r\n */</template><template autoinsert\="true" context\="constructorcomment_context" deleted\="false" description\="Comment for created constructors" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name\="constructorcomment">/**\r\n * ${tags}\r\n */</template><template autoinsert\="false" context\="filecomment_context" deleted\="false" description\="Comment for created Java files" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.filecomment" name\="filecomment">/* \r\n * Copyright IBM Corp. ${year}\r\n *\r\n * Licensed under the Apache License, Version 2.0 (the "License");\r\n * you may not use this file except in compliance with the License.\r\n * You may obtain a copy of the License at\r\n *\r\n * http\://www.apache.org/licenses/LICENSE-2.0\r\n *\r\n * Unless required by applicable law or agreed to in writing, software\r\n * distributed under the License is distributed on an "AS IS" BASIS,\r\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\n * See the License for the specific language governing permissions and\r\n * limitations under the License.\r\n */</template><template autoinsert\="true" context\="typecomment_context" deleted\="false" description\="Comment for created types" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.typecomment" name\="typecomment">/**\r\n * @author ${user}\r\n *\r\n * ${tags}\r\n */</template><template autoinsert\="true" context\="fieldcomment_context" deleted\="false" description\="Comment for fields" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name\="fieldcomment">/**\r\n * \r\n */</template><template autoinsert\="true" context\="methodcomment_context" deleted\="false" description\="Comment for non-overriding methods" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name\="methodcomment">/**\r\n * ${tags}\r\n */</template><template autoinsert\="true" context\="overridecomment_context" deleted\="false" description\="Comment for overriding methods" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name\="overridecomment">/* (non-Javadoc)\r\n * ${see_to_overridden}\r\n */</template><template autoinsert\="true" context\="delegatecomment_context" deleted\="false" description\="Comment for delegate methods" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name\="delegatecomment">/**\r\n * ${tags}\r\n * ${see_to_target}\r\n */</template><template autoinsert\="true" context\="newtype_context" deleted\="false" description\="Newly created files" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.newtype" name\="newtype">${filecomment}\r\n${package_declaration}\r\n\r\n${typecomment}\r\n${type_declaration}</template><template autoinsert\="true" context\="classbody_context" deleted\="false" description\="Code in new class type bodies" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.classbody" name\="classbody">\r\n</template><template autoinsert\="true" context\="interfacebody_context" deleted\="false" description\="Code in new interface type bodies" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.interfacebody" name\="interfacebody">\r\n</template><template autoinsert\="true" context\="enumbody_context" deleted\="false" description\="Code in new enum type bodies" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.enumbody" name\="enumbody">\r\n</template><template autoinsert\="true" context\="annotationbody_context" deleted\="false" description\="Code in new annotation type bodies" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.annotationbody" name\="annotationbody">\r\n</template><template autoinsert\="true" context\="catchblock_context" deleted\="false" description\="Code in new catch blocks" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.catchblock" name\="catchblock">// ${todo} Auto-generated catch block\r\n${exception_var}.printStackTrace();</template><template autoinsert\="true" context\="methodbody_context" deleted\="false" description\="Code in created method stubs" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.methodbody" name\="methodbody">// ${todo} Auto-generated method stub\r\n${body_statement}</template><template autoinsert\="true" context\="constructorbody_context" deleted\="false" description\="Code in created constructor stubs" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.constructorbody" name\="constructorbody">${body_statement}\r\n// ${todo} Auto-generated constructor stub</template><template autoinsert\="true" context\="getterbody_context" deleted\="false" description\="Code in created getters" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.getterbody" name\="getterbody">return ${field};</template><template autoinsert\="true" context\="setterbody_context" deleted\="false" description\="Code in created setters" enabled\="true" id\="org.eclipse.jdt.ui.text.codetemplates.setterbody" name\="setterbody">${field} \= ${param};</template></templates>

‎gp-ant-task/pom.xml‎

Lines changed: 60 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,64 @@
11
<?xml version="1.0"?>
2-
<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
3-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
4-
<modelVersion>4.0.0</modelVersion>
5-
<parent>
6-
<groupId>com.ibm.g11n.pipeline</groupId>
7-
<artifactId>gp-java-tools</artifactId>
8-
<version>1.1.5-SNAPSHOT</version>
9-
</parent>
10-
<groupId>com.ibm.g11n.pipeline.ant</groupId>
11-
<artifactId>gp-ant-task</artifactId>
12-
<name>Globalization Pipeline Ant Tasks</name>
13-
<properties>
14-
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
15-
</properties>
16-
<dependencies>
17-
<dependency>
18-
<groupId>org.apache.ant</groupId>
19-
<artifactId>ant</artifactId>
20-
<version>1.9.9</version>
21-
<scope>provided</scope>
22-
</dependency>
23-
<dependency>
24-
<groupId>com.google.code.gson</groupId>
25-
<artifactId>gson</artifactId>
26-
<version>2.4</version>
27-
</dependency>
28-
<dependency>
2+
<project
3+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
4+
xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
5+
<modelVersion>4.0.0</modelVersion>
6+
<parent>
297
<groupId>com.ibm.g11n.pipeline</groupId>
30-
<artifactId>gp-java-client</artifactId>
31-
<version>1.1.3</version>
32-
</dependency>
33-
<dependency>
34-
<groupId>com.ibm.g11n.pipeline</groupId>
35-
<artifactId>gp-res-filter</artifactId>
36-
<version>1.1.4</version>
37-
</dependency>
38-
</dependencies>
39-
<build>
40-
<plugins>
41-
<plugin>
42-
<groupId>org.apache.maven.plugins</groupId>
43-
<artifactId>maven-shade-plugin</artifactId>
44-
<version>2.4.2</version>
45-
<executions>
46-
<execution>
47-
<phase>package</phase>
48-
<goals>
49-
<goal>shade</goal>
50-
</goals>
51-
<configuration>
52-
<shadedArtifactAttached>true</shadedArtifactAttached>
53-
<shadedClassifierName>with-dependencies</shadedClassifierName>
54-
</configuration>
55-
</execution>
56-
</executions>
57-
</plugin>
58-
</plugins>
8+
<artifactId>gp-java-tools</artifactId>
9+
<version>1.1.5-SNAPSHOT</version>
10+
</parent>
11+
<groupId>com.ibm.g11n.pipeline.ant</groupId>
12+
<artifactId>gp-ant-task</artifactId>
13+
<name>Globalization Pipeline Ant Tasks</name>
14+
15+
<properties>
16+
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
17+
</properties>
18+
19+
<dependencies>
20+
<dependency>
21+
<groupId>org.apache.ant</groupId>
22+
<artifactId>ant</artifactId>
23+
<version>1.9.9</version>
24+
<scope>provided</scope>
25+
</dependency>
26+
<dependency>
27+
<groupId>com.google.code.gson</groupId>
28+
<artifactId>gson</artifactId>
29+
<version>2.4</version>
30+
</dependency>
31+
<dependency>
32+
<groupId>com.ibm.g11n.pipeline</groupId>
33+
<artifactId>gp-java-client</artifactId>
34+
<version>1.1.3</version>
35+
</dependency>
36+
<dependency>
37+
<groupId>com.ibm.g11n.pipeline</groupId>
38+
<artifactId>gp-res-filter</artifactId>
39+
<version>1.1.5-SNAPSHOT</version>
40+
</dependency>
41+
</dependencies>
42+
43+
<build>
44+
<plugins>
45+
<plugin>
46+
<groupId>org.apache.maven.plugins</groupId>
47+
<artifactId>maven-shade-plugin</artifactId>
48+
<version>2.4.2</version>
49+
<executions>
50+
<execution>
51+
<phase>package</phase>
52+
<goals>
53+
<goal>shade</goal>
54+
</goals>
55+
<configuration>
56+
<shadedArtifactAttached>true</shadedArtifactAttached>
57+
<shadedClassifierName>with-dependencies</shadedClassifierName>
58+
</configuration>
59+
</execution>
60+
</executions>
61+
</plugin>
62+
</plugins>
5963
</build>
6064
</project>

‎gp-ant-task/src/main/java/com/ibm/g11n/pipeline/ant/BundleSet.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ public void setBundleLayout(BundleLayout bundleLayout) {
202202

203203
/**
204204
* Supporting code for nested element of targetLanguage as required for custom ant build script
205-
* @return
205+
* @param tl A {#@link TargetLanguage}
206206
*/
207207
public void addTargetLanguage(TargetLanguage tl) {
208208
targetLangs.add(tl);

‎gp-ant-task/src/main/java/com/ibm/g11n/pipeline/ant/GPBaseTask.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ public void execute() {
119119
* <li>A set of fields specified by &lt;credentials&gt; in pom.xml</li>
120120
* </ol>
121121
* @return An instance of ServiceClient.
122-
* @throws BuildExcpetion on a failure.
122+
* @throws BuildException on a failure.
123123
*/
124124
protected ServiceClient getServiceClient() {
125125
if (gpClient == null) {

‎gp-ant-task/src/main/java/com/ibm/g11n/pipeline/ant/LanguageMap.java‎

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -31,41 +31,35 @@ public class LanguageMap {
3131
private String from;
3232

3333
/**
34-
* The language name which should be used when downloading files in "from" languange
34+
* The language name which should be used when downloading files in "from" language
3535
*/
3636
private String to;
3737

3838
/**
39-
*
40-
* @return from
39+
* @return from A language mapped from
4140
*/
4241
public String getFrom() {
4342
return from;
4443
}
4544

4645
/**
47-
*
48-
* @param from
46+
* @param from A language mapped from
4947
*/
5048
public void setFrom(String from) {
5149
this.from = from;
5250
}
5351

5452
/**
55-
*
56-
* @return to
53+
* @return to A language mapped to
5754
*/
5855
public String getTo() {
5956
return to;
6057
}
6158

6259
/**
63-
*
64-
* @param to
60+
* @param to A language mapped to
6561
*/
6662
public void setTo(String to) {
6763
this.to = to;
6864
}
69-
70-
7165
}

‎gp-ant-task/src/main/java/com/ibm/g11n/pipeline/ant/TargetLanguage.java‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,22 +33,25 @@ public class TargetLanguage {
3333
/**
3434
* a target language
3535
*/
36-
String lang;
36+
private String lang;
3737

38+
/**
39+
* Constructor.
40+
*/
3841
public TargetLanguage() {
3942
}
4043

4144
/**
42-
*
43-
* @param targetLang
45+
* Sets a target language.
46+
* @param targetLang A target language
4447
*/
4548
public void setLang(String targetLang) {
4649
this.lang = targetLang;
4750
}
4851

4952
/**
50-
*
51-
* @return targetLang
53+
* Returns a target language
54+
* @return targetLang A target language
5255
*/
5356
public String getLang() {
5457
return lang;

0 commit comments

Comments
 (0)