Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Turn on doclint and fix javadoc syntax #10

Merged
merged 1 commit into from
Jan 27, 2025
+38 −47
Merged

Turn on doclint and fix javadoc syntax #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions resources/javaTemplates/JavaClassTemplate.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1470,7 +1470,7 @@ public {{#abstract}}abstract{{/abstract}} class {{{className}}} extends {{{super

/**
* Adds a {{{propertyName}}} to the initial collection
* @parameter {{{propertyName}}} {{{propertyName}}} to add
* @param {{{propertyName}}} {{{propertyName}}} to add
* @return this for chaining
**/
public {{{className}}}Builder {{{adder}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -1482,7 +1482,7 @@ public {{#abstract}}abstract{{/abstract}} class {{{className}}} extends {{{super

/**
* Adds all elements from a collection to the initial {{{propertyName}}} collection
* @parameter {{{propertyName}}}Collection collection to initialize the {{{propertyName}}}
* @param {{{propertyName}}}Collection collection to initialize the {{{propertyName}}}
* @return this for chaining
**/
public {{{className}}}Builder {{{addAller}}}(Collection<{{{type}}}> {{{propertyName}}}Collection) {
Expand All @@ -1496,7 +1496,7 @@ public {{#abstract}}abstract{{/abstract}} class {{{className}}} extends {{{super

/**
* Adds a {{{propertyName}}} to the initial collection
* @parameter {{{propertyName}}} {{{propertyName}}} to add
* @param {{{propertyName}}} {{{propertyName}}} to add
* @return this for chaining
**/
public {{{className}}}Builder {{{adder}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -1508,7 +1508,7 @@ public {{#abstract}}abstract{{/abstract}} class {{{className}}} extends {{{super

/**
* Adds all elements from a collection to the initial {{{propertyName}}} collection
* @parameter {{{propertyName}}}Collection collection to initialize the {{{propertyName}}}
* @param {{{propertyName}}}Collection collection to initialize the {{{propertyName}}}
* @return this for chaining
**/
public {{{className}}}Builder {{{addAller}}}(Collection<{{{type}}}> {{{propertyName}}}Collection) {
Expand All @@ -1522,7 +1522,7 @@ public {{#abstract}}abstract{{/abstract}} class {{{className}}} extends {{{super

/**
* Adds a {{{propertyName}}} to the initial collection
* @parameter {{{propertyName}}} {{{propertyName}}} to add
* @param {{{propertyName}}} {{{propertyName}}} to add
* @return this for chaining
**/
public {{{className}}}Builder {{{adder}}}(String {{{propertyName}}}) {
Expand All @@ -1534,7 +1534,7 @@ public {{#abstract}}abstract{{/abstract}} class {{{className}}} extends {{{super

/**
* Adds all elements from a collection to the initial {{{propertyName}}} collection
* @parameter {{{propertyName}}}Collection collection to initialize the {{{propertyName}}}
* @param {{{propertyName}}}Collection collection to initialize the {{{propertyName}}}
* @return this for chaining
**/
public {{{className}}}Builder {{{addAller}}}(Collection<String> {{{propertyName}}}Collection) {
Expand All @@ -1548,7 +1548,7 @@ public {{#abstract}}abstract{{/abstract}} class {{{className}}} extends {{{super

/**
* Adds a {{{propertyName}}} to the initial collection
* @parameter {{{propertyName}}} {{{propertyName}}} to add
* @param {{{propertyName}}} {{{propertyName}}} to add
* @return this for chaining
**/
public {{{className}}}Builder {{{adder}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -1560,7 +1560,7 @@ public {{#abstract}}abstract{{/abstract}} class {{{className}}} extends {{{super

/**
* Adds all elements from a collection to the initial {{{propertyName}}} collection
* @parameter {{{propertyName}}}Collection collection to initialize the {{{propertyName}}}
* @param {{{propertyName}}}Collection collection to initialize the {{{propertyName}}}
* @return this for chaining
**/
public {{{className}}}Builder {{{addAller}}}(Set<{{{type}}}> {{{propertyName}}}Set) {
Expand All @@ -1574,7 +1574,7 @@ public {{#abstract}}abstract{{/abstract}} class {{{className}}} extends {{{super

/**
* Sets the initial value of {{{propertyName}}}
* @parameter {{{propertyName}}} value to set
* @param {{{propertyName}}} value to set
* @return this for chaining
**/
public {{{className}}}Builder {{{setter}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -1586,7 +1586,7 @@ public {{#abstract}}abstract{{/abstract}} class {{{className}}} extends {{{super

/**
* Sets the initial value of {{{propertyName}}}
* @parameter {{{propertyName}}} value to set
* @param {{{propertyName}}} value to set
* @return this for chaining
**/
public {{{className}}}Builder {{{setter}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -1598,7 +1598,7 @@ public {{#abstract}}abstract{{/abstract}} class {{{className}}} extends {{{super

/**
* Sets the initial value of {{{propertyName}}}
* @parameter {{{propertyName}}} value to set
* @param {{{propertyName}}} value to set
* @return this for chaining
**/
public {{{className}}}Builder {{{setter}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -1610,7 +1610,7 @@ public {{#abstract}}abstract{{/abstract}} class {{{className}}} extends {{{super

/**
* Sets the initial value of {{{propertyName}}}
* @parameter {{{propertyName}}} value to set
* @param {{{propertyName}}} value to set
* @return this for chaining
**/
public {{{className}}}Builder {{{setter}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -1622,7 +1622,7 @@ public {{#abstract}}abstract{{/abstract}} class {{{className}}} extends {{{super

/**
* Sets the initial value of {{{propertyName}}}
* @parameter {{{propertyName}}} value to set
* @param {{{propertyName}}} value to set
* @return this for chaining
**/
public {{{className}}}Builder {{{setter}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -1634,7 +1634,7 @@ public {{#abstract}}abstract{{/abstract}} class {{{className}}} extends {{{super

/**
* Sets the initial value of {{{propertyName}}}
* @parameter {{{propertyName}}} value to set
* @param {{{propertyName}}} value to set
* @return this for chaining
**/
public {{{className}}}Builder {{{setter}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -1646,7 +1646,7 @@ public {{#abstract}}abstract{{/abstract}} class {{{className}}} extends {{{super

/**
* Sets the initial value of {{{propertyName}}}
* @parameter {{{propertyName}}} value to set
* @param {{{propertyName}}} value to set
* @return this for chaining
**/
public {{{className}}}Builder {{{setter}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -1658,7 +1658,7 @@ public {{#abstract}}abstract{{/abstract}} class {{{className}}} extends {{{super

/**
* Sets the initial value of {{{propertyName}}}
* @parameter {{{propertyName}}} value to set
* @param {{{propertyName}}} value to set
* @return this for chaining
**/
public {{{className}}}Builder {{{setter}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -1670,7 +1670,7 @@ public {{#abstract}}abstract{{/abstract}} class {{{className}}} extends {{{super

/**
* Sets the initial value of {{{propertyName}}}
* @parameter {{{propertyName}}} value to set
* @param {{{propertyName}}} value to set
* @return this for chaining
**/
public {{{className}}}Builder {{{setter}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -1682,7 +1682,7 @@ public {{#abstract}}abstract{{/abstract}} class {{{className}}} extends {{{super

/**
* Sets the initial value of {{{propertyName}}}
* @parameter {{{propertyName}}} value to set
* @param {{{propertyName}}} value to set
* @return this for chaining
**/
public {{{className}}}Builder {{{setter}}}(String {{{propertyName}}}) {
Expand Down
13 changes: 2 additions & 11 deletions resources/javaTemplates/PomTemplate.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,6 @@
<dependency-check-maven.version>8.0.1</dependency-check-maven.version>
</properties>
<profiles>
<profile>
<id>doclint-java8-disable</id>
<activation>
<jdk>[1.8,)</jdk>
</activation>
<properties>
<javadoc.opts>-Xdoclint:none</javadoc.opts>
</properties>
</profile>
<profile>
<id>test</id>
<dependencies>
Expand Down Expand Up @@ -175,7 +166,7 @@
<configuration>
<quiet>true</quiet>
<notimestamp>true</notimestamp>
<additionalOptions>-Xdoclint:none</additionalOptions>
<doclint>all,-missing</doclint>
</configuration>
<executions>
<execution>
Expand Down Expand Up @@ -265,4 +256,4 @@
</plugin>
</plugins>
</build>
</project>
</project>
36 changes: 18 additions & 18 deletions resources/javaTemplates/TestValuesGeneratorTemplate.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ public class TestValuesGenerator {
{{#objectPropertyValueCollection}}
/**
* Adds a {{{propertyName}}} to the initial collection
* @parameter {{{propertyName}}} {{{propertyName}}} to add
* @param {{{propertyName}}} {{{propertyName}}} to add
* @return this for chaining
**/
public Mock{{{className}}}Builder {{{adder}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -95,7 +95,7 @@ public class TestValuesGenerator {

/**
* Adds all elements from a collection to the initial {{{propertyName}}} collection
* @parameter {{{propertyName}}}Collection collection to initialize the {{{propertyName}}}
* @param {{{propertyName}}}Collection collection to initialize the {{{propertyName}}}
* @return this for chaining
**/
public Mock{{{className}}}Builder {{{addAller}}}(Collection<{{{type}}}> {{{propertyName}}}Collection) {
Expand All @@ -109,7 +109,7 @@ public class TestValuesGenerator {

/**
* Adds a {{{propertyName}}} to the initial collection
* @parameter {{{propertyName}}} {{{propertyName}}} to add
* @param {{{propertyName}}} {{{propertyName}}} to add
* @return this for chaining
**/
public Mock{{{className}}}Builder {{{adder}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -121,7 +121,7 @@ public class TestValuesGenerator {

/**
* Adds all elements from a collection to the initial {{{propertyName}}} collection
* @parameter {{{propertyName}}}Collection collection to initialize the {{{propertyName}}}
* @param {{{propertyName}}}Collection collection to initialize the {{{propertyName}}}
* @return this for chaining
**/
public Mock{{{className}}}Builder {{{addAller}}}(Collection<{{{type}}}> {{{propertyName}}}Collection) {
Expand All @@ -135,7 +135,7 @@ public class TestValuesGenerator {

/**
* Adds a {{{propertyName}}} to the initial collection
* @parameter {{{propertyName}}} {{{propertyName}}} to add
* @param {{{propertyName}}} {{{propertyName}}} to add
* @return this for chaining
**/
public Mock{{{className}}}Builder {{{adder}}}(String {{{propertyName}}}) {
Expand All @@ -147,7 +147,7 @@ public class TestValuesGenerator {

/**
* Adds all elements from a collection to the initial {{{propertyName}}} collection
* @parameter {{{propertyName}}}Collection collection to initialize the {{{propertyName}}}
* @param {{{propertyName}}}Collection collection to initialize the {{{propertyName}}}
* @return this for chaining
**/
public Mock{{{className}}}Builder {{{addAller}}}(Collection<String> {{{propertyName}}}Collection) {
Expand All @@ -161,7 +161,7 @@ public class TestValuesGenerator {

/**
* Adds a {{{propertyName}}} to the initial collection
* @parameter {{{propertyName}}} {{{propertyName}}} to add
* @param {{{propertyName}}} {{{propertyName}}} to add
* @return this for chaining
**/
public Mock{{{className}}}Builder {{{adder}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -173,7 +173,7 @@ public class TestValuesGenerator {

/**
* Adds all elements from a collection to the initial {{{propertyName}}} collection
* @parameter {{{propertyName}}}Collection collection to initialize the {{{propertyName}}}
* @param {{{propertyName}}}Collection collection to initialize the {{{propertyName}}}
* @return this for chaining
**/
public Mock{{{className}}}Builder {{{addAller}}}(Set<{{{type}}}> {{{propertyName}}}Set) {
Expand All @@ -187,7 +187,7 @@ public class TestValuesGenerator {

/**
* Sets the initial value of {{{propertyName}}}
* @parameter {{{propertyName}}} value to set
* @param {{{propertyName}}} value to set
* @return this for chaining
**/
public Mock{{{className}}}Builder {{{setter}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -199,7 +199,7 @@ public class TestValuesGenerator {

/**
* Sets the initial value of {{{propertyName}}}
* @parameter {{{propertyName}}} value to set
* @param {{{propertyName}}} value to set
* @return this for chaining
**/
public Mock{{{className}}}Builder {{{setter}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -211,7 +211,7 @@ public class TestValuesGenerator {

/**
* Sets the initial value of {{{propertyName}}}
* @parameter {{{propertyName}}} value to set
* @param {{{propertyName}}} value to set
* @return this for chaining
**/
public Mock{{{className}}}Builder {{{setter}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -223,7 +223,7 @@ public class TestValuesGenerator {

/**
* Sets the initial value of {{{propertyName}}}
* @parameter {{{propertyName}}} value to set
* @param {{{propertyName}}} value to set
* @return this for chaining
**/
public Mock{{{className}}}Builder {{{setter}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -235,7 +235,7 @@ public class TestValuesGenerator {

/**
* Sets the initial value of {{{propertyName}}}
* @parameter {{{propertyName}}} value to set
* @param {{{propertyName}}} value to set
* @return this for chaining
**/
public Mock{{{className}}}Builder {{{setter}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -247,7 +247,7 @@ public class TestValuesGenerator {

/**
* Sets the initial value of {{{propertyName}}}
* @parameter {{{propertyName}}} value to set
* @param {{{propertyName}}} value to set
* @return this for chaining
**/
public Mock{{{className}}}Builder {{{setter}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -259,7 +259,7 @@ public class TestValuesGenerator {

/**
* Sets the initial value of {{{propertyName}}}
* @parameter {{{propertyName}}} value to set
* @param {{{propertyName}}} value to set
* @return this for chaining
**/
public Mock{{{className}}}Builder {{{setter}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -271,7 +271,7 @@ public class TestValuesGenerator {

/**
* Sets the initial value of {{{propertyName}}}
* @parameter {{{propertyName}}} value to set
* @param {{{propertyName}}} value to set
* @return this for chaining
**/
public Mock{{{className}}}Builder {{{setter}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -283,7 +283,7 @@ public class TestValuesGenerator {

/**
* Sets the initial value of {{{propertyName}}}
* @parameter {{{propertyName}}} value to set
* @param {{{propertyName}}} value to set
* @return this for chaining
**/
public Mock{{{className}}}Builder {{{setter}}}({{{type}}} {{{propertyName}}}) {
Expand All @@ -295,7 +295,7 @@ public class TestValuesGenerator {

/**
* Sets the initial value of {{{propertyName}}}
* @parameter {{{propertyName}}} value to set
* @param {{{propertyName}}} value to set
* @return this for chaining
**/
public Mock{{{className}}}Builder {{{setter}}}(String {{{propertyName}}}) {
Expand Down
Loading