Added doxygen snippets to cc-mode

These snippets follow the doxygen syntax available on http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html
AndreaCrotti · Jun 4, 2015 · 81fc8e9 · 81fc8e9
1 parent d2865b7
commit 81fc8e9
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 0 deletions.
diff --git a/cc-mode/file_description b/cc-mode/file_description
@@ -0,0 +1,13 @@
+# -*- mode: snippet -*-
+#cotributor: Henrique Jung <henriquenj@gmail.com>
+#name: File description
+#key: \file
+#group: doxygen
+# --
+/**
+ *   \file ${1:`(file-name-nondirectory(buffer-file-name))`}
+ *   \brief ${2:A Documented file.}
+ ${3:*
+ *  ${4:Detailed description}
+ *
+}*/
diff --git a/cc-mode/function_description b/cc-mode/function_description
@@ -0,0 +1,14 @@
+# -*- mode: snippet -*-
+#cotributor: Henrique Jung <henriquenj@gmail.com>
+#name: Function description
+#key: \brief
+#group: doxygen
+# --
+/**
+ *  \brief ${1:function description}
+ ${2:*
+ *  ${3:Detailed description}
+ *
+ }*  \param ${4:param}
+ *  \return ${5:return type}
+ */
diff --git a/cc-mode/member_description b/cc-mode/member_description
@@ -0,0 +1,7 @@
+# -*- mode: snippet -*-
+#cotributor: Henrique Jung <henriquenj@gmail.com>
+#name: Member description
+#key: !<
+#group: doxygen
+# --
+/*!< ${1:Detailed description after the member} */