34 lines
686 B
Text
34 lines
686 B
Text
# Documentation
|
|
snippet docf "function documentation" b
|
|
#' @description
|
|
#'
|
|
#' ${1:function description}
|
|
#'
|
|
#' ${2:@param ${3:name}::${4:Type} ${5:Description}}
|
|
#'
|
|
#' ${6:@returns ${7:name}::${8:Type} ${9:Description}}
|
|
#'
|
|
#' @examples
|
|
#'
|
|
#' ${10: function call examples}
|
|
endsnippet
|
|
|
|
snippet doct "type definition" b
|
|
#' @description
|
|
#'
|
|
#' ${1:type description}
|
|
#'
|
|
#' ${2:@field ${3:name}::${4:Type} ${5:Description}}
|
|
#'
|
|
#' @examples
|
|
#'
|
|
#' ${10: constructor examples}
|
|
endsnippet
|
|
|
|
snippet par "function parameter documentation" b
|
|
#' @param ${1:name}::${2:Type} ${0:Description}
|
|
endsnippet
|
|
|
|
snippet fld "type field documentation" b
|
|
#' @field ${1:name}::${2:Type} ${0:Description}
|
|
endsnippet
|