Skip to content

Commit 90e2fbc

Browse files
committed
Cleanup javadoc for CodegenProperty
1 parent ddb15d4 commit 90e2fbc

1 file changed

Lines changed: 66 additions & 18 deletions

File tree

modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenProperty.java

Lines changed: 66 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,11 @@ public class CodegenProperty implements Cloneable, IJsonSchemaValidationProperti
6666
@Setter public String baseType;
6767
@Getter @Setter
6868
public String containerType;
69+
/**
70+
* language-specified container type (e.g. `dict` in python for map)
71+
*/
6972
@Getter @Setter
70-
public String containerTypeMapped; // language-specified container type (e.g. `dict` in python for map)
73+
public String containerTypeMapped;
7174

7275
/**
7376
* The value of the 'title' attribute in the OpenAPI schema.
@@ -151,8 +154,14 @@ public class CodegenProperty implements Cloneable, IJsonSchemaValidationProperti
151154
public boolean isBinary;
152155
public boolean isFile;
153156
public boolean isBoolean;
154-
public boolean isDate; // full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21
155-
public boolean isDateTime; // the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
157+
/**
158+
* full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21
159+
*/
160+
public boolean isDate;
161+
/**
162+
* the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
163+
*/
164+
public boolean isDateTime;
156165
public boolean isUuid;
157166
public boolean isUri;
158167
public boolean isEmail;
@@ -176,44 +185,83 @@ public class CodegenProperty implements Cloneable, IJsonSchemaValidationProperti
176185
* datatype is the generic inner parameter of a std::optional for C++, or Optional (Java)
177186
*/
178187
public boolean isOptional;
179-
public boolean isEnum; // true if the enum is defined inline
180-
public boolean isInnerEnum; // Enums declared inline will be located inside the generic model, changing how the enum is referenced in some cases.
181-
public boolean isEnumRef; // true if it's a reference to an enum
188+
/**
189+
* true if the enum is defined inline
190+
*/
191+
public boolean isEnum;
192+
/**
193+
* Enums declared inline will be located inside the generic model, changing how the enum is referenced in some cases.
194+
*/
195+
public boolean isInnerEnum;
196+
/**
197+
* true if it's a reference to an enum
198+
*/
199+
public boolean isEnumRef;
182200
public boolean isReadOnly;
183201
public boolean isWriteOnly;
184202
public boolean isNullable;
185203
public boolean isSelfReference;
186204
public boolean isCircularReference;
187205
public boolean isDiscriminator;
188-
public boolean isNew; // true when this property overrides an inherited property
189-
public Boolean isOverridden; // true if the property is a parent property (not defined in child/current schema)
206+
/**
207+
* true when this property overrides an inherited property
208+
*/
209+
public boolean isNew;
210+
/**
211+
* true if the property is a parent property (not defined in child/current schema)
212+
*/
213+
public Boolean isOverridden;
190214
@Getter @Setter
191215
public List<String> _enum;
192216
@Getter @Setter
193217
public Map<String, Object> allowableValues;
194-
// If 'additionalProperties' is not set, items is null.
195-
// If 'additionalProperties' is set to a type or refers to a type, 'items' provides the type information for
196-
// the undeclared properties.
218+
/**
219+
* <ul>
220+
* <li>If 'additionalProperties' is not set, items is null.</li>
221+
* <li>If 'additionalProperties' is set to a type or refers to a type, 'items' provides the type information for the undeclared properties.</li>
222+
* </ul>
223+
*/
197224
public CodegenProperty items;
198225
public CodegenProperty additionalProperties;
199-
public List<CodegenProperty> vars = new ArrayList<CodegenProperty>(); // all properties (without parent's properties)
226+
/**
227+
* all properties (without parent's properties)
228+
*/
229+
public List<CodegenProperty> vars = new ArrayList<CodegenProperty>();
200230
public List<CodegenProperty> requiredVars = new ArrayList<>();
201231
public CodegenProperty mostInnerItems;
202232
@Getter @Setter
203233
public Map<String, Object> vendorExtensions = new HashMap<String, Object>();
204-
public boolean hasValidation; // true if pattern, maximum, etc are set (only used in the mustache template)
234+
/**
235+
* true if pattern, maximum, etc are set (only used in the mustache template)
236+
*/
237+
public boolean hasValidation;
205238
public boolean isInherited;
206239
public String discriminatorValue;
207240

241+
/**
242+
* property name in lower case
243+
*/
208244
@Getter @Setter
209-
public String nameInLowerCase; // property name in lower case
245+
public String nameInLowerCase;
246+
/**
247+
* property name in camel case (e.g. modifiedDate)
248+
*/
210249
@Getter @Setter
211-
public String nameInCamelCase; // property name in camel case (e.g. modifiedDate)
250+
public String nameInCamelCase;
251+
/**
252+
* property name in pascal case (e.g. ModifiedDate)
253+
*/
212254
@Getter @Setter
213-
public String nameInPascalCase; // property name in pascal case (e.g. ModifiedDate)
255+
public String nameInPascalCase;
256+
/**
257+
* property name in upper snake case
258+
*/
214259
@Getter
215-
public String nameInSnakeCase; // property name in upper snake case
216-
// enum name based on the property name, usually use as a prefix (e.g. VAR_NAME) for enum name (e.g. VAR_NAME_VALUE1)
260+
public String nameInSnakeCase;
261+
262+
/**
263+
* enum name based on the property name, usually use as a prefix (e.g. VAR_NAME) for enum name (e.g. VAR_NAME_VALUE1)
264+
*/
217265
@Getter @Setter
218266
public String enumName;
219267
public Integer maxItems;

0 commit comments

Comments
 (0)