Skip to content

Commit c8a4c60

Browse files
authored
[ALL-GENS;DEV-EX / EASE-OF-USE] - add javadocs to all codegens pointing to the dirs containing their relevant templates (#23606)
* add javadocs to all codegens pointing to the dirs containing the relevant templates * implement CR suggestions * move annotations below javadocs
1 parent 664ba3d commit c8a4c60

161 files changed

Lines changed: 517 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@
3232
import java.util.EnumSet;
3333
import java.util.Locale;
3434

35+
/**
36+
* <p>Mustache templates are located in {@code src/main/resources/Ada/}.
37+
*/
3538
public class AdaCodegen extends AbstractAdaCodegen implements CodegenConfig {
3639

3740
public AdaCodegen() {

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@
3131
import java.util.EnumSet;
3232
import java.util.Locale;
3333

34+
/**
35+
* <p>Mustache templates are located in {@code src/main/resources/Ada/}.
36+
*/
3437
public class AdaServerCodegen extends AbstractAdaCodegen implements CodegenConfig {
3538

3639
public AdaServerCodegen() {

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,12 @@
3535
import static org.openapitools.codegen.utils.CamelizeOption.LOWERCASE_FIRST_LETTER;
3636
import static org.openapitools.codegen.utils.StringUtils.camelize;
3737

38+
/**
39+
* <p>Mustache templates are located in
40+
* {@code src/main/resources/android/} (root templates shared across all libraries) and
41+
* {@code src/main/resources/android/libraries/} (library-specific overrides).
42+
* A library-specific template shadows a root-level template of the same name.
43+
*/
3844
public class AndroidClientCodegen extends DefaultCodegen implements CodegenConfig {
3945
private final Logger LOGGER = LoggerFactory.getLogger(AndroidClientCodegen.class);
4046
public static final String USE_ANDROID_MAVEN_GRADLE_PLUGIN = "useAndroidMavenGradlePlugin";

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,9 @@
3030
import java.util.List;
3131

3232

33+
/**
34+
* <p>Mustache templates are located in {@code src/main/resources/apache2/}.
35+
*/
3336
public class Apache2ConfigCodegen extends DefaultCodegen implements CodegenConfig {
3437
public static final String USER_INFO_PATH = "userInfoPath";
3538
private final Logger LOGGER = LoggerFactory.getLogger(Apache2ConfigCodegen.class);

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@
3737

3838
import static org.openapitools.codegen.utils.StringUtils.camelize;
3939

40+
/**
41+
* <p>Mustache templates are located in {@code src/main/resources/apex/}.
42+
*/
4043
public class ApexClientCodegen extends AbstractApexCodegen {
4144

4245
private static final String CLASS_PREFIX = "classPrefix";

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
* basic asciidoc markup generator.
4242
*
4343
* @see <a href="https://asciidoctor.org">asciidoctor</a>
44+
* <p>Mustache templates are located in {@code src/main/resources/asciidoc-documentation/}.
4445
*/
4546
public class AsciidocDocumentationCodegen extends DefaultCodegen implements CodegenConfig {
4647

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@
3939
import static java.util.UUID.randomUUID;
4040
import static org.openapitools.codegen.CodegenConstants.X_CSHARP_VALUE_TYPE;
4141

42+
/**
43+
* <p>Mustache templates are located in {@code src/main/resources/aspnetcore/}.
44+
*/
4245
public class AspNetServerCodegen extends AbstractCSharpCodegen {
4346

4447
public static final String USE_SWASHBUCKLE = "useSwashbuckle";

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@
1212

1313
import static java.util.UUID.randomUUID;
1414

15+
/**
16+
* <p>Mustache templates are located in {@code src/main/resources/aspnet-fastendpoints/}.
17+
*/
1518
public class AspnetFastendpointsServerCodegen extends AbstractCSharpCodegen implements CodegenConfig {
1619

1720
public static final String PROJECT_NAME = "projectName";

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@
3636

3737
import static org.openapitools.codegen.utils.StringUtils.camelize;
3838

39+
/**
40+
* <p>Mustache templates are located in {@code src/main/resources/avro-schema/}.
41+
*/
3942
public class AvroSchemaCodegen extends DefaultCodegen implements CodegenConfig {
4043
private final Logger LOGGER = LoggerFactory.getLogger(AvroSchemaCodegen.class);
4144
private static final String AVRO = "avro-schema";

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@
4040
import static org.openapitools.codegen.utils.StringUtils.camelize;
4141
import static org.openapitools.codegen.utils.StringUtils.underscore;
4242

43+
/**
44+
* <p>Mustache templates are located in {@code src/main/resources/bash/}.
45+
*/
4346
public class BashClientCodegen extends DefaultCodegen implements CodegenConfig {
4447
private final Logger LOGGER = LoggerFactory.getLogger(BashClientCodegen.class);
4548

0 commit comments

Comments
 (0)