aboutsummaryrefslogtreecommitdiff
path: root/vim/bundle/vim-snippets/UltiSnips/julia.snippets
diff options
context:
space:
mode:
Diffstat (limited to 'vim/bundle/vim-snippets/UltiSnips/julia.snippets')
-rw-r--r--vim/bundle/vim-snippets/UltiSnips/julia.snippets34
1 files changed, 34 insertions, 0 deletions
diff --git a/vim/bundle/vim-snippets/UltiSnips/julia.snippets b/vim/bundle/vim-snippets/UltiSnips/julia.snippets
new file mode 100644
index 0000000..259c5f4
--- /dev/null
+++ b/vim/bundle/vim-snippets/UltiSnips/julia.snippets
@@ -0,0 +1,34 @@
+# 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