update r api doc (#12679)

Author: wing328

modules/openapi-generator/src/main/resources/r/api.mustache

@@ -150,6 +150,13 @@
   "{{classname}}",
   public = list(
     api_client = NULL,
+    #' Initialize a new {{{classname}}}.
+    #'
+    #' @description
+    #' Initialize a new {{{classname}}}.
+    #'
+    #' @param api_client An instance of API client.
+    #' @export
     initialize = function(api_client) {
       if (!missing(api_client)) {
         self$api_client <- api_client
@@ -159,6 +166,23 @@
       }
     },
     {{#operation}}
+    #' {{{summary}}}
+    #'
+    #' @description
+    #' {{{description}}}{{^description}}{{{summary}}}{{/description}}
+    #'
+    {{#requiredParams}}
+    #' @param {{{paramName}}} {{{description}}}
+    {{/requiredParams}}
+    {{#optionalParams}}
+    #' @param {{{paramName}}} (optional) {{{description}}}{{#defaultValue}} (default value: {{{.}}}){{/defaultValue}}
+    {{/optionalParams}}
+    {{#returnType}}
+    #' @param data_file (optional) name of the data file to save the result
+    {{/returnType}}
+    #' @param ... Other optional arguments
+    #' @return {{{returnType}}}{{^returnType}}void{{/returnType}}
+    #' @export
     {{{operationId}}} = function({{#requiredParams}}{{paramName}}, {{/requiredParams}}{{#optionalParams}}{{paramName}}={{^defaultValue}}NULL{{/defaultValue}}{{{defaultValue}}}, {{/optionalParams}}{{#returnType}}data_file=NULL, {{/returnType}}...) {
       api_response <- self${{{operationId}}}WithHttpInfo({{#allParams}}{{paramName}}, {{/allParams}}{{#returnType}}data_file = data_file, {{/returnType}}...)
       resp <- api_response$response
@@ -172,7 +196,23 @@
         api_response
       }
     },
-
+    #' {{{summary}}}
+    #'
+    #' @description
+    #' {{{description}}}{{^description}}{{{summary}}}{{/description}}
+    #'
+    {{#requiredParams}}
+    #' @param {{{paramName}}} {{{description}}}
+    {{/requiredParams}}
+    {{#optionalParams}}
+    #' @param {{{paramName}}} (optional) {{{description}}}{{#defaultValue}} (default value: {{{.}}}){{/defaultValue}}
+    {{/optionalParams}}
+    {{#returnType}}
+    #' @param data_file (optional) name of the data file to save the result
+    {{/returnType}}
+    #' @param ... Other optional arguments
+    #' @return API response ({{{returnType}}}{{^returnType}}void{{/returnType}}) with additional information such as HTTP status code, headers
+    #' @export
     {{{operationId}}}WithHttpInfo = function({{#requiredParams}}{{paramName}}, {{/requiredParams}}{{#optionalParams}}{{paramName}}={{^defaultValue}}NULL{{/defaultValue}}{{{defaultValue}}}, {{/optionalParams}}{{#returnType}}data_file = NULL, {{/returnType}}...) {
       args <- list(...)
       query_params <- list()

samples/client/petstore/R/R/fake_api.R

@@ -73,6 +73,13 @@ FakeApi <- R6::R6Class(
   "FakeApi",
   public = list(
     api_client = NULL,
+    #' Initialize a new FakeApi.
+    #'
+    #' @description
+    #' Initialize a new FakeApi.
+    #'
+    #' @param api_client An instance of API client.
+    #' @export
     initialize = function(api_client) {
       if (!missing(api_client)) {
         self$api_client <- api_client
@@ -81,6 +88,17 @@ FakeApi <- R6::R6Class(
         self$api_client <- ApiClient$new()
       }
     },
+    #' test data_file to ensure it's escaped correctly
+    #'
+    #' @description
+    #' test data_file to ensure it's escaped correctly
+    #'
+    #' @param dummy dummy required parameter
+    #' @param var_data_file (optional) header data file
+    #' @param data_file (optional) name of the data file to save the result
+    #' @param ... Other optional arguments
+    #' @return User
+    #' @export
     FakeDataFile = function(dummy, var_data_file=NULL, data_file=NULL, ...) {
       api_response <- self$FakeDataFileWithHttpInfo(dummy, var_data_file, data_file = data_file, ...)
       resp <- api_response$response
@@ -94,7 +112,17 @@ FakeApi <- R6::R6Class(
         api_response
       }
     },
-
+    #' test data_file to ensure it's escaped correctly
+    #'
+    #' @description
+    #' test data_file to ensure it's escaped correctly
+    #'
+    #' @param dummy dummy required parameter
+    #' @param var_data_file (optional) header data file
+    #' @param data_file (optional) name of the data file to save the result
+    #' @param ... Other optional arguments
+    #' @return API response (User) with additional information such as HTTP status code, headers
+    #' @export
     FakeDataFileWithHttpInfo = function(dummy, var_data_file=NULL, data_file = NULL, ...) {
       args <- list(...)
       query_params <- list()