[cpp-restsdk] Support multi-line descriptions (OpenAPITools#753)

* Update IndentedLambda to take optional prefix * Add `multiline_comment_4` to CppRestSdkClient * Update cpp-restsdk example
ihsmarkitoss · Aug 9, 2018 · 1af8ed4 · 1af8ed4
1 parent 9075054
commit 1af8ed4
Show file tree

Hide file tree

Showing 39 changed files with 88 additions and 39 deletions.
diff --git a/...penapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractCppCodegen.java b/...penapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractCppCodegen.java
@@ -19,13 +19,17 @@
 
 import io.swagger.v3.oas.models.media.Schema;
 
+import com.google.common.collect.ImmutableMap;
+import com.samskivert.mustache.Mustache;
 import org.openapitools.codegen.CodegenConfig;
 import org.openapitools.codegen.CodegenProperty;
 import org.openapitools.codegen.DefaultCodegen;
+import org.openapitools.codegen.mustache.IndentedLambda;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.util.Arrays;
+import java.util.Map;
 
 abstract public class AbstractCppCodegen extends DefaultCodegen implements CodegenConfig {
     private static final Logger LOGGER = LoggerFactory.getLogger(AbstractCppCodegen.class);
@@ -242,4 +246,23 @@ public String toBooleanGetter(String name) {
     public String getTypeDeclaration(String str) {
         return "std::shared_ptr<" + toModelName(str) + ">";
     }
+
+    public void processOpts() {
+        super.processOpts();
+        addMustacheLambdas(additionalProperties);
+    }
+
+    private void addMustacheLambdas(Map<String, Object> objs) {
+
+        Map<String, Mustache.Lambda> lambdas = new ImmutableMap.Builder<String, Mustache.Lambda>()
+                .put("multiline_comment_4", new IndentedLambda(4, " ", "///"))
+                .build();
+
+        if (objs.containsKey("lambda")) {
+            LOGGER.warn("A property named 'lambda' already exists. Mustache lambdas renamed from 'lambda' to '_lambda'.");
+            objs.put("_lambda", lambdas);
+        } else {
+            objs.put("lambda", lambdas);
+        }
+    }
 }
diff --git a/...les/openapi-generator/src/main/java/org/openapitools/codegen/mustache/IndentedLambda.java b/...les/openapi-generator/src/main/java/org/openapitools/codegen/mustache/IndentedLambda.java
@@ -43,13 +43,14 @@
  */
 public class IndentedLambda implements Mustache.Lambda {
     private final int prefixSpaceCount;
+    private final String prefix;
     private int spaceCode;
 
     /**
      * Constructs a new instance of {@link IndentedLambda}, with an indent count of 4 spaces
      */
     public IndentedLambda() {
-        this(4, " ");
+        this(4, " ", null);
     }
 
     /**
@@ -59,15 +60,38 @@ public IndentedLambda() {
      * @param indentionCharacter String representation of the character used in the indent (e.g. " ", "\t", ".").
      */
     public IndentedLambda(int prefixSpaceCount, String indentionCharacter) {
-        this(prefixSpaceCount, Character.codePointAt(indentionCharacter, 0));
+        this(prefixSpaceCount, Character.codePointAt(indentionCharacter, 0), null);
+    }
+
+    /**
+     * Constructs a new instance of {@link IndentedLambda}, with customized indent count and intention character
+     *
+     * @param prefixSpaceCount   The number of indented characters to apply as a prefix to a fragment.
+     * @param indentionCharacter String representation of the character used in the indent (e.g. " ", "\t", ".").
+     * @param prefix             An optional prefix to prepend before the line (useful for multi-line comments).
+     */
+    public IndentedLambda(int prefixSpaceCount, String indentionCharacter, String prefix) {
+        this(prefixSpaceCount, Character.codePointAt(indentionCharacter, 0), prefix);
     }
 
     /**
      * Constructs a new instance of {@link IndentedLambda}
      *
      * @param prefixSpaceCount The number of indented characters to apply as a prefix to a fragment.
+     * @param indentionCodePoint Code point of the single character used for indentation.
      */
     private IndentedLambda(int prefixSpaceCount, int indentionCodePoint) {
+        this(prefixSpaceCount, indentionCodePoint, null);
+    }
+
+    /**
+     * Constructs a new instance of {@link IndentedLambda}
+     *
+     * @param prefixSpaceCount The number of indented characters to apply as a prefix to a fragment.
+     * @param indentionCodePoint Code point of the single character used for indentation.
+     * @param prefix             An optional prefix to prepend before the line (useful for multi-line comments).
+     */
+    private IndentedLambda(int prefixSpaceCount, int indentionCodePoint, String prefix) {
         if (prefixSpaceCount <= 0) {
             throw new IllegalArgumentException("prefixSpaceCount must be greater than 0");
         }
@@ -78,6 +102,7 @@ private IndentedLambda(int prefixSpaceCount, int indentionCodePoint) {
 
         this.prefixSpaceCount = prefixSpaceCount;
         this.spaceCode = indentionCodePoint;
+        this.prefix = prefix;
     }
 
     @Override
@@ -96,6 +121,7 @@ public void execute(Template.Fragment fragment, Writer writer) throws IOExceptio
             // So, we want to skip the first line.
             if (i > 0) {
                 sb.append(prefixedIndention);
+                if (prefix != null) sb.append(prefix);
             }
 
             sb.append(line);

diff --git a/modules/openapi-generator/src/main/resources/cpp-rest-sdk-client/api-header.mustache b/modules/openapi-generator/src/main/resources/cpp-rest-sdk-client/api-header.mustache
@@ -62,7 +62,7 @@ public:
     /// {{notes}}
     /// </remarks>
     {{#allParams}}
-    /// <param name="{{paramName}}">{{description}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}</param>
+    /// <param name="{{paramName}}">{{#lambda.multiline_comment_4}}{{description}}{{/lambda.multiline_comment_4}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}</param>
     {{/allParams}}
     pplx::task<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}> {{operationId}}(
         {{#allParams}}

diff --git a/samples/client/petstore/cpp-restsdk/.openapi-generator/VERSION b/samples/client/petstore/cpp-restsdk/.openapi-generator/VERSION
@@ -1 +1 @@
-3.1.2-SNAPSHOT
+3.2.1-SNAPSHOT
diff --git a/samples/client/petstore/cpp-restsdk/ApiClient.cpp b/samples/client/petstore/cpp-restsdk/ApiClient.cpp
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/ApiClient.h b/samples/client/petstore/cpp-restsdk/ApiClient.h
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/ApiConfiguration.cpp b/samples/client/petstore/cpp-restsdk/ApiConfiguration.cpp
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/ApiConfiguration.h b/samples/client/petstore/cpp-restsdk/ApiConfiguration.h
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/ApiException.cpp b/samples/client/petstore/cpp-restsdk/ApiException.cpp
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/ApiException.h b/samples/client/petstore/cpp-restsdk/ApiException.h
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/HttpContent.cpp b/samples/client/petstore/cpp-restsdk/HttpContent.cpp
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/HttpContent.h b/samples/client/petstore/cpp-restsdk/HttpContent.h
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/IHttpBody.h b/samples/client/petstore/cpp-restsdk/IHttpBody.h
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/JsonBody.cpp b/samples/client/petstore/cpp-restsdk/JsonBody.cpp
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/JsonBody.h b/samples/client/petstore/cpp-restsdk/JsonBody.h
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/ModelBase.cpp b/samples/client/petstore/cpp-restsdk/ModelBase.cpp
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/ModelBase.h b/samples/client/petstore/cpp-restsdk/ModelBase.h
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/MultipartFormData.cpp b/samples/client/petstore/cpp-restsdk/MultipartFormData.cpp
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/MultipartFormData.h b/samples/client/petstore/cpp-restsdk/MultipartFormData.h
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/Object.cpp b/samples/client/petstore/cpp-restsdk/Object.cpp
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/Object.h b/samples/client/petstore/cpp-restsdk/Object.h
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/api/PetApi.cpp b/samples/client/petstore/cpp-restsdk/api/PetApi.cpp
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/api/PetApi.h b/samples/client/petstore/cpp-restsdk/api/PetApi.h
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/api/StoreApi.cpp b/samples/client/petstore/cpp-restsdk/api/StoreApi.cpp
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/api/StoreApi.h b/samples/client/petstore/cpp-restsdk/api/StoreApi.h
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/api/UserApi.cpp b/samples/client/petstore/cpp-restsdk/api/UserApi.cpp
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/api/UserApi.h b/samples/client/petstore/cpp-restsdk/api/UserApi.h
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/model/ApiResponse.cpp b/samples/client/petstore/cpp-restsdk/model/ApiResponse.cpp
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/model/ApiResponse.h b/samples/client/petstore/cpp-restsdk/model/ApiResponse.h
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/model/Category.cpp b/samples/client/petstore/cpp-restsdk/model/Category.cpp
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/model/Category.h b/samples/client/petstore/cpp-restsdk/model/Category.h
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/model/Order.cpp b/samples/client/petstore/cpp-restsdk/model/Order.cpp
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/model/Order.h b/samples/client/petstore/cpp-restsdk/model/Order.h
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */

diff --git a/samples/client/petstore/cpp-restsdk/model/Pet.cpp b/samples/client/petstore/cpp-restsdk/model/Pet.cpp
@@ -4,7 +4,7 @@
  *
  * OpenAPI spec version: 1.0.0
  *
- * NOTE: This class is auto generated by OpenAPI-Generator 3.1.2-SNAPSHOT.
+ * NOTE: This class is auto generated by OpenAPI-Generator 3.2.1-SNAPSHOT.
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */