vim/UltiSnips
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Added option to use doxygen style comments in smart def and smart class.

Browse Source
This commit is contained in:
rygwdn@gmail.com 2010-07-30 21:47:36 -03:00
parent f88076636e
commit 897cca031e
1 changed files with 21 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
UltiSnips/python.snippets
View File

@ -18,6 +18,11 @@ endsnippet
########## ##########
# COMMON # # COMMON #
########## ##########
# The smart def and smart class snippets use a global option called
# "g:ultisnips_python_style" which, if set to "doxygen" will use doxygen
# style comments in docstrings.
snippet class "smart class" b snippet class "smart class" b
class ${1:MyClass}(${2:object}): class ${1:MyClass}(${2:object}):
""" ${3:Docstring for $1 }""" """ ${3:Docstring for $1 }"""
@ -34,7 +39,11 @@ if args:
snip += "" snip += ""
for arg in args: for arg in args:
snip += ":%s: description" % arg style = snip.opt("g:ultisnips_python_style", "normal")
if style == "doxygen":
snip += "@param %s TODO" % arg
else:
snip += ":%s: TODO" % arg
if args: if args:
snip += '"""' snip += '"""'
@ -63,12 +72,21 @@ args = [arg for arg in args if arg and arg != "self"]
if args: if args:
snip += "" snip += ""
snip.locals["style"] = style = snip.opt("g:ultisnips_python_style", "normal")
for arg in args: for arg in args:
snip += ":%s: description" % arg if style == "doxygen":
snip += "@param %s TODO" % arg
else:
snip += ":%s: TODO" % arg
`${4: `${4:
:returns: ${5:description} `!p
style = snip.locals["style"]
if style == "doxygen":
snip.rv = "@return"
else:
snip.rv = ":returns:"` ${5:TODO}
}""" }"""
${0:pass} ${0:pass}