loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-06-18 23:00:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

[BUG][R] Fix documentation in R package (#4580)

Browse Source 
* wip: fix documentation tags

* update model.mustache

* update template for documentation

* update mustache templates

* update mustache templates

* run ./bin/r-petstore and update R pkg docs
This commit is contained in:
Marcel Ramos 2019-11-25 21:38:56 -05:00 committed by William Cheng
parent 498c9b8a47
commit 2d22ae90fc
11 changed files with 46 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
modules/openapi-generator/src/main/resources/r/api.mustache vendored
View File

@ -26,7 +26,7 @@
#' \item \emph{ @param } {{paramName}} list( {{dataType}} )
{{/isPrimitiveType}}
{{^isPrimitiveType}}
#' \item \emph{ @param } {{paramName}} list( \link[{{packageName}}:{{baseType}}]{ {{dataType}} } )
#' \item \emph{ @param } {{paramName}} list( \link{{=<% %>=}}{<%dataType%>}<%={{ }}=%> )
{{/isPrimitiveType}}
{{/items}}
{{/isListContainer}}
@ -35,7 +35,7 @@
#' \item \emph{ @param } {{paramName}} named list( {{dataType}} )
{{/isPrimitiveType}}
{{^isPrimitiveType}}
#' \item \emph{ @param } {{paramName}} named list( \link[{{packageName}}:{{baseType}}]{ {{dataType}} } )
#' \item \emph{ @param } {{paramName}} named list( \link{{=<% %>=}}{<%dataType%>}<%={{ }}=%> )
{{/isPrimitiveType}}
{{/isMapContainer}}
{{/isContainer}}
@ -44,14 +44,14 @@
#' \item \emph{ @param } {{paramName}} {{dataType}}
{{/isPrimitiveType}}
{{^isPrimitiveType}}
#' \item \emph{ @param } {{paramName}} \link[{{packageName}}:{{baseType}}]{ {{dataType}} }
#' \item \emph{ @param } {{paramName}} \link{{=<% %>=}}{<%dataType%>}<%={{ }}=%>
{{/isPrimitiveType}}
{{/isContainer}}
{{/isEnum}}
{{/allParams}}
{{#returnType}}
{{^returnTypeIsPrimitive}}
#' \item \emph{ @returnType } \link[{{packageName}}:{{returnBaseType}}]{ {{#returnContainer}}{{#isListContainer}}list({{returnBaseType}}){{/isListContainer}}{{#isMapContainer}}named list({{returnBaseType}}){{/isMapContainer}}{{/returnContainer}}{{^returnContainer}}{{returnType}}{{/returnContainer}} } \cr
#' \item \emph{ @returnType } {{#returnContainer}}{{#isListContainer}}list( {{/isListContainer}}{{#isMapContainer}}named list( {{/isMapContainer}}{{/returnContainer}}\link{{=<% %>=}}{<%#returnContainer%><%={{ }}=%>{{returnBaseType}}{{/returnContainer}}{{^returnContainer}}{{returnType}}{{=<% %>=}}<%/returnContainer%>}<%={{ }}=%>{{#returnContainer}}{{#isListContainer}} ){{/isListContainer}}{{#isMapContainer}} ){{/isMapContainer}}{{/returnContainer}} \cr
{{/returnTypeIsPrimitive}}
{{/returnType}}
#'

2
modules/openapi-generator/src/main/resources/r/model.mustache vendored
View File

@ -6,7 +6,7 @@
#' @description {{classname}} Class
#' @format An \code{R6Class} generator object
{{#vars}}
#' @field {{baseName}} {{title}} {{^isPrimitiveType}} \link[{{packageName}}:{{complexType}}]{ {{/isPrimitiveType}} {{#isContainer}} {{#isListContainer}}list({{#items}}{{dataType}}{{/items}}){{/isListContainer}}{{#isMapContainer}}named list({{#items}}{{dataType}}{{/items}}){{/isMapContainer}} {{/isContainer}}{{^isContainer}}{{dataType}}{{/isContainer}} {{^isPrimitiveType}} } {{/isPrimitiveType}} {{^required}}[optional]{{/required}}
#' @field {{baseName}} {{title}} {{#isContainer}}{{#isListContainer}}list( {{/isListContainer}}{{#isMapContainer}}named list( {{/isMapContainer}}{{/isContainer}}{{^isPrimitiveType}}\link{{=<% %>=}}{<%/isPrimitiveType%><%={{ }}=%>{{#isContainer}}{{#items}}{{dataType}}{{/items}}{{/isContainer}}{{^isContainer}}{{dataType}}{{/isContainer}}{{=<% %>=}}<%^isPrimitiveType%>}<%={{ }}=%>{{/isPrimitiveType}}{{#isContainer}}{{#isListContainer}} ){{/isListContainer}}{{#isMapContainer}} ){{/isMapContainer}}{{/isContainer}} {{^required}}[optional]{{/required}}
#'
{{/vars}}
#'

4
samples/client/petstore/R/R/pet.R
View File

@ -12,13 +12,13 @@
#' @format An \code{R6Class} generator object
#' @field id integer [optional]
#'
#' @field category \link[petstore:Category]{ Category } [optional]
#' @field category \link{Category} [optional]
#'
#' @field name character
#'
#' @field photoUrls list( character )
#'
#' @field tags \link[petstore:Tag]{ list(Tag) } [optional]
#' @field tags list( \link{Tag} ) [optional]
#'
#' @field status character [optional]
#'

12
samples/client/petstore/R/R/pet_api.R
View File

@ -18,7 +18,7 @@
#'
#'
#' \itemize{
#' \item \emph{ @param } body \link[petstore:Pet]{ Pet }
#' \item \emph{ @param } body \link{Pet}
#'
#'
#' \item status code : 405 | Invalid input
@ -52,7 +52,7 @@
#'
#' \itemize{
#' \item \emph{ @param } status Enum < [available, pending, sold] >
#' \item \emph{ @returnType } \link[petstore:Pet]{ list(Pet) } \cr
#' \item \emph{ @returnType } list( \link{Pet} ) \cr
#'
#'
#' \item status code : 200 | successful operation
@ -76,7 +76,7 @@
#'
#' \itemize{
#' \item \emph{ @param } tags list( character )
#' \item \emph{ @returnType } \link[petstore:Pet]{ list(Pet) } \cr
#' \item \emph{ @returnType } list( \link{Pet} ) \cr
#'
#'
#' \item status code : 200 | successful operation
@ -100,7 +100,7 @@
#'
#' \itemize{
#' \item \emph{ @param } pet.id integer
#' \item \emph{ @returnType } \link[petstore:Pet]{ Pet } \cr
#' \item \emph{ @returnType } \link{Pet} \cr
#'
#'
#' \item status code : 200 | successful operation
@ -130,7 +130,7 @@
#'
#'
#' \itemize{
#' \item \emph{ @param } body \link[petstore:Pet]{ Pet }
#' \item \emph{ @param } body \link{Pet}
#'
#'
#' \item status code : 400 | Invalid ID supplied
@ -181,7 +181,7 @@
#' \item \emph{ @param } pet.id integer
#' \item \emph{ @param } additional.metadata character
#' \item \emph{ @param } file data.frame
#' \item \emph{ @returnType } \link[petstore:ApiResponse]{ ModelApiResponse } \cr
#' \item \emph{ @returnType } \link{ModelApiResponse} \cr
#'
#'
#' \item status code : 200 | successful operation

6
samples/client/petstore/R/R/store_api.R
View File

@ -57,7 +57,7 @@
#'
#' \itemize{
#' \item \emph{ @param } order.id integer
#' \item \emph{ @returnType } \link[petstore:Order]{ Order } \cr
#' \item \emph{ @returnType } \link{Order} \cr
#'
#'
#' \item status code : 200 | successful operation
@ -87,8 +87,8 @@
#'
#'
#' \itemize{
#' \item \emph{ @param } body \link[petstore:Order]{ Order }
#' \item \emph{ @returnType } \link[petstore:Order]{ Order } \cr
#' \item \emph{ @param } body \link{Order}
#' \item \emph{ @returnType } \link{Order} \cr
#'
#'
#' \item status code : 200 | successful operation

10
samples/client/petstore/R/R/user_api.R
View File

@ -18,7 +18,7 @@
#' This can only be done by the logged in user.
#'
#' \itemize{
#' \item \emph{ @param } body \link[petstore:User]{ User }
#' \item \emph{ @param } body \link{User}
#'
#'
#' \item status code : 0 | successful operation
@ -34,7 +34,7 @@
#'
#'
#' \itemize{
#' \item \emph{ @param } body list( \link[petstore:User]{ User } )
#' \item \emph{ @param } body list( \link{User} )
#'
#'
#' \item status code : 0 | successful operation
@ -50,7 +50,7 @@
#'
#'
#' \itemize{
#' \item \emph{ @param } body list( \link[petstore:User]{ User } )
#' \item \emph{ @param } body list( \link{User} )
#'
#'
#' \item status code : 0 | successful operation
@ -90,7 +90,7 @@
#'
#' \itemize{
#' \item \emph{ @param } username character
#' \item \emph{ @returnType } \link[petstore:User]{ User } \cr
#' \item \emph{ @returnType } \link{User} \cr
#'
#'
#' \item status code : 200 | successful operation
@ -162,7 +162,7 @@
#'
#' \itemize{
#' \item \emph{ @param } username character
#' \item \emph{ @param } body \link[petstore:User]{ User }
#' \item \emph{ @param } body \link{User}
#'
#'
#' \item status code : 400 | Invalid user supplied