mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-06-19 07:10:52 +00:00
[BUG][R] Fix documentation in R package (#4580)
* 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:
parent
498c9b8a47
commit
2d22ae90fc
@ -26,7 +26,7 @@
|
|||||||
#' \item \emph{ @param } {{paramName}} list( {{dataType}} )
|
#' \item \emph{ @param } {{paramName}} list( {{dataType}} )
|
||||||
{{/isPrimitiveType}}
|
{{/isPrimitiveType}}
|
||||||
{{^isPrimitiveType}}
|
{{^isPrimitiveType}}
|
||||||
#' \item \emph{ @param } {{paramName}} list( \link[{{packageName}}:{{baseType}}]{ {{dataType}} } )
|
#' \item \emph{ @param } {{paramName}} list( \link{{=<% %>=}}{<%dataType%>}<%={{ }}=%> )
|
||||||
{{/isPrimitiveType}}
|
{{/isPrimitiveType}}
|
||||||
{{/items}}
|
{{/items}}
|
||||||
{{/isListContainer}}
|
{{/isListContainer}}
|
||||||
@ -35,7 +35,7 @@
|
|||||||
#' \item \emph{ @param } {{paramName}} named list( {{dataType}} )
|
#' \item \emph{ @param } {{paramName}} named list( {{dataType}} )
|
||||||
{{/isPrimitiveType}}
|
{{/isPrimitiveType}}
|
||||||
{{^isPrimitiveType}}
|
{{^isPrimitiveType}}
|
||||||
#' \item \emph{ @param } {{paramName}} named list( \link[{{packageName}}:{{baseType}}]{ {{dataType}} } )
|
#' \item \emph{ @param } {{paramName}} named list( \link{{=<% %>=}}{<%dataType%>}<%={{ }}=%> )
|
||||||
{{/isPrimitiveType}}
|
{{/isPrimitiveType}}
|
||||||
{{/isMapContainer}}
|
{{/isMapContainer}}
|
||||||
{{/isContainer}}
|
{{/isContainer}}
|
||||||
@ -44,14 +44,14 @@
|
|||||||
#' \item \emph{ @param } {{paramName}} {{dataType}}
|
#' \item \emph{ @param } {{paramName}} {{dataType}}
|
||||||
{{/isPrimitiveType}}
|
{{/isPrimitiveType}}
|
||||||
{{^isPrimitiveType}}
|
{{^isPrimitiveType}}
|
||||||
#' \item \emph{ @param } {{paramName}} \link[{{packageName}}:{{baseType}}]{ {{dataType}} }
|
#' \item \emph{ @param } {{paramName}} \link{{=<% %>=}}{<%dataType%>}<%={{ }}=%>
|
||||||
{{/isPrimitiveType}}
|
{{/isPrimitiveType}}
|
||||||
{{/isContainer}}
|
{{/isContainer}}
|
||||||
{{/isEnum}}
|
{{/isEnum}}
|
||||||
{{/allParams}}
|
{{/allParams}}
|
||||||
{{#returnType}}
|
{{#returnType}}
|
||||||
{{^returnTypeIsPrimitive}}
|
{{^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}}
|
{{/returnTypeIsPrimitive}}
|
||||||
{{/returnType}}
|
{{/returnType}}
|
||||||
#'
|
#'
|
||||||
|
@ -6,7 +6,7 @@
|
|||||||
#' @description {{classname}} Class
|
#' @description {{classname}} Class
|
||||||
#' @format An \code{R6Class} generator object
|
#' @format An \code{R6Class} generator object
|
||||||
{{#vars}}
|
{{#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}}
|
{{/vars}}
|
||||||
#'
|
#'
|
||||||
|
@ -12,13 +12,13 @@
|
|||||||
#' @format An \code{R6Class} generator object
|
#' @format An \code{R6Class} generator object
|
||||||
#' @field id integer [optional]
|
#' @field id integer [optional]
|
||||||
#'
|
#'
|
||||||
#' @field category \link[petstore:Category]{ Category } [optional]
|
#' @field category \link{Category} [optional]
|
||||||
#'
|
#'
|
||||||
#' @field name character
|
#' @field name character
|
||||||
#'
|
#'
|
||||||
#' @field photoUrls list(character)
|
#' @field photoUrls list( character )
|
||||||
#'
|
#'
|
||||||
#' @field tags \link[petstore:Tag]{ list(Tag) } [optional]
|
#' @field tags list( \link{Tag} ) [optional]
|
||||||
#'
|
#'
|
||||||
#' @field status character [optional]
|
#' @field status character [optional]
|
||||||
#'
|
#'
|
||||||
|
@ -18,7 +18,7 @@
|
|||||||
#'
|
#'
|
||||||
#'
|
#'
|
||||||
#' \itemize{
|
#' \itemize{
|
||||||
#' \item \emph{ @param } body \link[petstore:Pet]{ Pet }
|
#' \item \emph{ @param } body \link{Pet}
|
||||||
#'
|
#'
|
||||||
#'
|
#'
|
||||||
#' \item status code : 405 | Invalid input
|
#' \item status code : 405 | Invalid input
|
||||||
@ -52,7 +52,7 @@
|
|||||||
#'
|
#'
|
||||||
#' \itemize{
|
#' \itemize{
|
||||||
#' \item \emph{ @param } status Enum < [available, pending, sold] >
|
#' \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
|
#' \item status code : 200 | successful operation
|
||||||
@ -76,7 +76,7 @@
|
|||||||
#'
|
#'
|
||||||
#' \itemize{
|
#' \itemize{
|
||||||
#' \item \emph{ @param } tags list( character )
|
#' \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
|
#' \item status code : 200 | successful operation
|
||||||
@ -100,7 +100,7 @@
|
|||||||
#'
|
#'
|
||||||
#' \itemize{
|
#' \itemize{
|
||||||
#' \item \emph{ @param } pet.id integer
|
#' \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
|
#' \item status code : 200 | successful operation
|
||||||
@ -130,7 +130,7 @@
|
|||||||
#'
|
#'
|
||||||
#'
|
#'
|
||||||
#' \itemize{
|
#' \itemize{
|
||||||
#' \item \emph{ @param } body \link[petstore:Pet]{ Pet }
|
#' \item \emph{ @param } body \link{Pet}
|
||||||
#'
|
#'
|
||||||
#'
|
#'
|
||||||
#' \item status code : 400 | Invalid ID supplied
|
#' \item status code : 400 | Invalid ID supplied
|
||||||
@ -181,7 +181,7 @@
|
|||||||
#' \item \emph{ @param } pet.id integer
|
#' \item \emph{ @param } pet.id integer
|
||||||
#' \item \emph{ @param } additional.metadata character
|
#' \item \emph{ @param } additional.metadata character
|
||||||
#' \item \emph{ @param } file data.frame
|
#' \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
|
#' \item status code : 200 | successful operation
|
||||||
|
@ -57,7 +57,7 @@
|
|||||||
#'
|
#'
|
||||||
#' \itemize{
|
#' \itemize{
|
||||||
#' \item \emph{ @param } order.id integer
|
#' \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
|
#' \item status code : 200 | successful operation
|
||||||
@ -87,8 +87,8 @@
|
|||||||
#'
|
#'
|
||||||
#'
|
#'
|
||||||
#' \itemize{
|
#' \itemize{
|
||||||
#' \item \emph{ @param } body \link[petstore:Order]{ Order }
|
#' \item \emph{ @param } body \link{Order}
|
||||||
#' \item \emph{ @returnType } \link[petstore:Order]{ Order } \cr
|
#' \item \emph{ @returnType } \link{Order} \cr
|
||||||
#'
|
#'
|
||||||
#'
|
#'
|
||||||
#' \item status code : 200 | successful operation
|
#' \item status code : 200 | successful operation
|
||||||
|
@ -18,7 +18,7 @@
|
|||||||
#' This can only be done by the logged in user.
|
#' This can only be done by the logged in user.
|
||||||
#'
|
#'
|
||||||
#' \itemize{
|
#' \itemize{
|
||||||
#' \item \emph{ @param } body \link[petstore:User]{ User }
|
#' \item \emph{ @param } body \link{User}
|
||||||
#'
|
#'
|
||||||
#'
|
#'
|
||||||
#' \item status code : 0 | successful operation
|
#' \item status code : 0 | successful operation
|
||||||
@ -34,7 +34,7 @@
|
|||||||
#'
|
#'
|
||||||
#'
|
#'
|
||||||
#' \itemize{
|
#' \itemize{
|
||||||
#' \item \emph{ @param } body list( \link[petstore:User]{ User } )
|
#' \item \emph{ @param } body list( \link{User} )
|
||||||
#'
|
#'
|
||||||
#'
|
#'
|
||||||
#' \item status code : 0 | successful operation
|
#' \item status code : 0 | successful operation
|
||||||
@ -50,7 +50,7 @@
|
|||||||
#'
|
#'
|
||||||
#'
|
#'
|
||||||
#' \itemize{
|
#' \itemize{
|
||||||
#' \item \emph{ @param } body list( \link[petstore:User]{ User } )
|
#' \item \emph{ @param } body list( \link{User} )
|
||||||
#'
|
#'
|
||||||
#'
|
#'
|
||||||
#' \item status code : 0 | successful operation
|
#' \item status code : 0 | successful operation
|
||||||
@ -90,7 +90,7 @@
|
|||||||
#'
|
#'
|
||||||
#' \itemize{
|
#' \itemize{
|
||||||
#' \item \emph{ @param } username character
|
#' \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
|
#' \item status code : 200 | successful operation
|
||||||
@ -162,7 +162,7 @@
|
|||||||
#'
|
#'
|
||||||
#' \itemize{
|
#' \itemize{
|
||||||
#' \item \emph{ @param } username character
|
#' \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
|
#' \item status code : 400 | Invalid user supplied
|
||||||
|
Loading…
x
Reference in New Issue
Block a user