Merge pull request #291 from dpitic/master

AndreaCrotti · web-flow · commit 9b210e3c0c94 · 2018-09-22T20:26:53.000+01:00
New Python class and function Doxygen snippets
diff --git a/snippets/c-lang-common/function_doxygen_doc b/snippets/c-lang-common/function_doxygen_doc
@@ -5,11 +5,11 @@
 # group: doxygen
 # --
 /**
- * @brief    ${1:function description}
+ * @brief      ${1:function description}
  *
- * @details  ${2:detailed description}
+ * @details    ${2:detailed description}
  *
- * @param    ${3:param}
+ * @param      ${3:param}
  *
- * @return   ${4:return type}
- */
+ * @return     ${4:return type}
+ */
diff --git a/snippets/nasm-mode/function_doxygen_doc b/snippets/nasm-mode/function_doxygen_doc
diff --git a/snippets/python-mode/class_doxygen_doc b/snippets/python-mode/class_doxygen_doc
@@ -0,0 +1,11 @@
+# -*- mode: snippet -*-
+# contributor: Dan Pitic <dpitic@gmail.com>
+# name: Class Doxygen Doc
+# key: doxy_class
+# group: doxygen
+# --
+"""
+@brief      ${1:class description}
+
+@details    ${2:detailed description}
+"""
diff --git a/snippets/python-mode/function_doxygen_doc b/snippets/python-mode/function_doxygen_doc
@@ -0,0 +1,15 @@
+# -*- mode: snippet -*-
+# contributor: Dan Pitic <dpitic@gmail.com>
+# name: Function Doxygen Doc
+# key: doxy_func
+# group: doxygen
+# --
+"""
+@brief      ${1:function description}
+
+@details    ${2:detailed description}
+
+@param      ${3:param}
+
+@return     ${4:return type}
+"""

Original file line number	Diff line number	Diff line change
`@@ -5,11 +5,11 @@`
`5`	`5`	`# group: doxygen`
`6`	`6`	`# --`
`7`	`7`	`/**`
`8`		`- * @brief ${1:function description}`
	`8`	`+ * @brief ${1:function description}`
`9`	`9`	`*`
`10`		`- * @details ${2:detailed description}`
	`10`	`+ * @details ${2:detailed description}`
`11`	`11`	`*`
`12`		`- * @param ${3:param}`
	`12`	`+ * @param ${3:param}`
`13`	`13`	`*`
`14`		`- * @return ${4:return type}`
`15`		`- */`
	`14`	`+ * @return ${4:return type}`
	`15`	`+ */`