From 6817b8bbf51e090b426ff627720f3f4917ce7646 Mon Sep 17 00:00:00 2001 From: Dan Pitic Date: Tue, 3 Apr 2018 19:30:08 +0800 Subject: [PATCH 1/5] New c-mode Doxygen function documentation using Javadoc style tags. --- snippets/c-mode/function_doxygen_doc | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 snippets/c-mode/function_doxygen_doc diff --git a/snippets/c-mode/function_doxygen_doc b/snippets/c-mode/function_doxygen_doc new file mode 100644 index 000000000..4f7d5e482 --- /dev/null +++ b/snippets/c-mode/function_doxygen_doc @@ -0,0 +1,14 @@ +# -*- mode: snippet -*- +# contributor: Dan Pitic +# name: Function Doxygen Doc +# key: \doxydoc +# group: doxygen +# -- +/** + * @brief ${1:function description} + ${2:* + * ${3:Detailed description} + * +}* @param ${4:param} + * @return ${5:return type} + */ From 770391935911f8b6c6eaa36eef93695c9c5360a9 Mon Sep 17 00:00:00 2001 From: Dan Pitic Date: Tue, 3 Apr 2018 20:44:05 +0800 Subject: [PATCH 2/5] Removed double space from doc block. --- snippets/c-mode/function_doxygen_doc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/snippets/c-mode/function_doxygen_doc b/snippets/c-mode/function_doxygen_doc index 4f7d5e482..a8cd9bccf 100644 --- a/snippets/c-mode/function_doxygen_doc +++ b/snippets/c-mode/function_doxygen_doc @@ -5,10 +5,10 @@ # group: doxygen # -- /** - * @brief ${1:function description} + * @brief ${1:function description} ${2:* - * ${3:Detailed description} + * ${3:Detailed description} * -}* @param ${4:param} - * @return ${5:return type} +}* @param ${4:param} + * @return ${5:return type} */ From 0d7e493de083393b8c11cbc8c34bdef441243ba5 Mon Sep 17 00:00:00 2001 From: Dan Pitic Date: Mon, 9 Apr 2018 19:05:15 +0800 Subject: [PATCH 3/5] Moved alternate c/c++ function documentation block from c-mode to c-lang-common so that the snippet will be available for both c & c++ programs. --- snippets/{c-mode => c-lang-common}/function_doxygen_doc | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename snippets/{c-mode => c-lang-common}/function_doxygen_doc (100%) diff --git a/snippets/c-mode/function_doxygen_doc b/snippets/c-lang-common/function_doxygen_doc similarity index 100% rename from snippets/c-mode/function_doxygen_doc rename to snippets/c-lang-common/function_doxygen_doc From 357e3f0368442348744c47ede08f63400a26a7f1 Mon Sep 17 00:00:00 2001 From: Dan Pitic Date: Wed, 25 Apr 2018 10:04:19 +0800 Subject: [PATCH 4/5] Reformatted c function Doxygen documentation block. Added @details section. --- snippets/c-lang-common/function_doxygen_doc | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/snippets/c-lang-common/function_doxygen_doc b/snippets/c-lang-common/function_doxygen_doc index a8cd9bccf..22d66988a 100644 --- a/snippets/c-lang-common/function_doxygen_doc +++ b/snippets/c-lang-common/function_doxygen_doc @@ -1,14 +1,14 @@ # -*- mode: snippet -*- # contributor: Dan Pitic # name: Function Doxygen Doc -# key: \doxydoc +# key: \c-func-description # group: doxygen # -- /** - * @brief ${1:function description} - ${2:* - * ${3:Detailed description} + * @brief ${1:function description} * -}* @param ${4:param} - * @return ${5:return type} - */ + * @details ${2:detailed description} + * + * @param ${3:param} + * @return ${4:return type} + */ \ No newline at end of file From 9af3d22f05cfb911ece726b303b2a8db12041faf Mon Sep 17 00:00:00 2001 From: Dan Pitic Date: Sat, 16 Jun 2018 11:47:19 +0800 Subject: [PATCH 5/5] Changed C Doxygen function block trigger to doxy to make it easier to use. Added new nasm Doxygen function block document snippet. --- snippets/c-lang-common/function_doxygen_doc | 5 +++-- snippets/nasm-mode/function_doc | 15 +++++++++++++++ 2 files changed, 18 insertions(+), 2 deletions(-) create mode 100644 snippets/nasm-mode/function_doc diff --git a/snippets/c-lang-common/function_doxygen_doc b/snippets/c-lang-common/function_doxygen_doc index 22d66988a..0b8fec04c 100644 --- a/snippets/c-lang-common/function_doxygen_doc +++ b/snippets/c-lang-common/function_doxygen_doc @@ -1,7 +1,7 @@ # -*- mode: snippet -*- # contributor: Dan Pitic # name: Function Doxygen Doc -# key: \c-func-description +# key: doxy # group: doxygen # -- /** @@ -10,5 +10,6 @@ * @details ${2:detailed description} * * @param ${3:param} + * * @return ${4:return type} - */ \ No newline at end of file + */ diff --git a/snippets/nasm-mode/function_doc b/snippets/nasm-mode/function_doc new file mode 100644 index 000000000..e7be6de62 --- /dev/null +++ b/snippets/nasm-mode/function_doc @@ -0,0 +1,15 @@ +# -*- mode: snippet -*- +#name : Assembly Function Doc +#key : doxy +#group : doxygen +#contributor : Dan Pitic +# -- +;; +;; @brief ${1:function description} +;; +;; @details ${2:detailed description} +;; +;; @param ${3:param} +;; +;; @return ${4:return} +;; \ No newline at end of file