From db3a57e104d718027f00daf6a6d80a8012e22c6a Mon Sep 17 00:00:00 2001 From: Felix Jung Date: Mon, 23 Jun 2014 12:37:34 +0200 Subject: [PATCH] Initial commit Adds snippets for function and type documentation, as used by the DataArrays package for Julia. Adds TODO snippet. --- UltiSnips/julia.snippets | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 UltiSnips/julia.snippets diff --git a/UltiSnips/julia.snippets b/UltiSnips/julia.snippets new file mode 100644 index 0000000..ac4929d --- /dev/null +++ b/UltiSnips/julia.snippets @@ -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