Initial commit

Adds snippets for function and type documentation, as used by the
DataArrays package for Julia.

Adds TODO snippet.
This commit is contained in:
Felix Jung 2014-06-23 12:37:34 +02:00
parent 79a0442e54
commit db3a57e104

38
UltiSnips/julia.snippets Normal file
View File

@ -0,0 +1,38 @@
# Documentation
snippet docf "function documentation"
#' @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"
#' @description
#'
#' ${1:type description}
#'
#' ${2:@field ${3:name}::${4:Type} ${5:Description}}
#'
#' @examples
#'
#' ${10: constructor examples}
endsnippet
snippet par "function parameter documentation"
#' @param ${1:name}::${2:Type} ${0:Description}
endsnippet
snippet fld "type field documentation"
#' @field ${1:name}::${2:Type} ${0:Description}
endsnippet
snippet todo "todo entry"
# TODO${1: (`whoami`, `date +%Y-%m-%d`)}: ${0}
endsnippet