Skip to content

Commit 01b23f0

Browse files
committed
Fix javadoc warnings
1 parent 1f6531e commit 01b23f0

File tree

8 files changed

+57
-0
lines changed

8 files changed

+57
-0
lines changed

model/src/main/java/io/wcm/devops/conga/model/environment/Environment.java

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,10 @@ public List<Node> getNodes() {
5151
return this.nodes;
5252
}
5353

54+
/**
55+
* Sets nodes.
56+
* @param nodes List of nodes
57+
*/
5458
public void setNodes(List<Node> nodes) {
5559
this.nodes = defaultEmptyList(nodes);
5660
}
@@ -64,6 +68,10 @@ public List<RoleConfig> getRoleConfig() {
6468
return this.roleConfig;
6569
}
6670

71+
/**
72+
* Sets role configurations.
73+
* @param roleConfig Configurations per role
74+
*/
6775
public void setRoleConfig(List<RoleConfig> roleConfig) {
6876
this.roleConfig = defaultEmptyList(roleConfig);
6977
}
@@ -77,6 +85,10 @@ public List<Tenant> getTenants() {
7785
return this.tenants;
7886
}
7987

88+
/**
89+
* Sets tenants.
90+
* @param tenants List of tenants
91+
*/
8092
public void setTenants(List<Tenant> tenants) {
8193
this.tenants = defaultEmptyList(tenants);
8294
}
@@ -90,6 +102,10 @@ public List<String> getDependencies() {
90102
return this.dependencies;
91103
}
92104

105+
/**
106+
* Sets dependencies.
107+
* @param dependencies List of dependencies
108+
*/
93109
public void setDependencies(List<String> dependencies) {
94110
this.dependencies = defaultEmptyList(dependencies);
95111
}
@@ -112,6 +128,7 @@ public Map<String, Map<String, Object>> getPluginConfig() {
112128
}
113129

114130
/**
131+
* Sets plugin configuration.
115132
* @param pluginConfig Plugin configuration parameter map
116133
*/
117134
public void setPluginConfig(Map<String, Map<String, Object>> pluginConfig) {

model/src/main/java/io/wcm/devops/conga/model/environment/Node.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ public String getNode() {
4646
return this.node;
4747
}
4848

49+
/**
50+
* Sets node name.
51+
* @param node Node name
52+
*/
4953
public void setNode(String node) {
5054
this.node = node;
5155
}
@@ -60,6 +64,10 @@ public List<String> getNodes() {
6064
return this.nodes;
6165
}
6266

67+
/**
68+
* Sets node names.
69+
* @param nodes List of node names
70+
*/
6371
public void setNodes(List<String> nodes) {
6472
this.nodes = defaultEmptyList(nodes);
6573
}
@@ -72,6 +80,10 @@ public List<NodeRole> getRoles() {
7280
return this.roles;
7381
}
7482

83+
/**
84+
* Sets roles.
85+
* @param roles Role assignments for node
86+
*/
7587
public void setRoles(List<NodeRole> roles) {
7688
this.roles = defaultEmptyList(roles);
7789
}

model/src/main/java/io/wcm/devops/conga/model/environment/NodeRole.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@ public String getRole() {
4444
return this.role;
4545
}
4646

47+
/**
48+
* Sets role name.
49+
* @param role Role name
50+
*/
4751
public void setRole(String role) {
4852
this.role = role;
4953
}
@@ -57,6 +61,10 @@ public String getVariant() {
5761
return this.variant;
5862
}
5963

64+
/**
65+
* Sets role variant name.
66+
* @param variant Role variant name
67+
*/
6068
public void setVariant(String variant) {
6169
this.variant = variant;
6270
}
@@ -70,6 +78,10 @@ public List<String> getVariants() {
7078
return this.variants;
7179
}
7280

81+
/**
82+
* Sets role variant names.
83+
* @param variants Role variant names
84+
*/
7385
public void setVariants(List<String> variants) {
7486
this.variants = variants;
7587
}

model/src/main/java/io/wcm/devops/conga/model/reader/AbstractModelReader.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232

3333
/**
3434
* Shared functionality for model readers.
35+
* @param <T> Model type
3536
*/
3637
public abstract class AbstractModelReader<T> implements ModelReader<T> {
3738

@@ -41,6 +42,7 @@ public abstract class AbstractModelReader<T> implements ModelReader<T> {
4142
private final Yaml yaml;
4243

4344
/**
45+
* Constructor.
4446
* @param yaml YAML
4547
*/
4648
protected AbstractModelReader(Yaml yaml) {

model/src/main/java/io/wcm/devops/conga/model/role/Role.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,10 @@ public List<RoleInherit> getInherits() {
4747
return this.inherits;
4848
}
4949

50+
/**
51+
* Sets inheritance relations.
52+
* @param inherits List of inheritance relations
53+
*/
5054
public void setInherits(List<RoleInherit> inherits) {
5155
this.inherits = defaultEmptyList(inherits);
5256
}

model/src/main/java/io/wcm/devops/conga/model/shared/Configurable.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ public interface Configurable {
3434
Map<String, Object> getConfig();
3535

3636
/**
37+
* Sets configuration parameters.
3738
* @param config Configuration parameter map
3839
*/
3940
void setConfig(Map<String, Object> config);

model/src/main/java/io/wcm/devops/conga/model/shared/LineEndings.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ public enum LineEndings {
4747
}
4848

4949
/**
50+
* Gets line ending characters.
5051
* @return Line ending characters
5152
*/
5253
public String getLineEnding() {

model/src/main/java/io/wcm/devops/conga/model/util/MapSplitter.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,10 +143,18 @@ private SplitResult(@NotNull Map<String, Object> matching, @NotNull Map<String,
143143
this.unmatching = unmatching;
144144
}
145145

146+
/**
147+
* Gets matching map entries.
148+
* @return Matching map entries
149+
*/
146150
public @NotNull Map<String, Object> getMatching() {
147151
return this.matching;
148152
}
149153

154+
/**
155+
* Gets unmatching map entries.
156+
* @return Unmatching map entries
157+
*/
150158
public @NotNull Map<String, Object> getUnmatching() {
151159
return this.unmatching;
152160
}

0 commit comments

Comments
 (0)