Skip to content

Commit 6a5f130

Browse files
dpiticAndreaCrotti
authored andcommitted
New c-mode Doxygen function documentation using Javadoc style tags. (#264)
* New c-mode Doxygen function documentation using Javadoc style tags. * Removed double space from doc block. * 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. * Reformatted c function Doxygen documentation block. Added @details section. * Changed C Doxygen function block trigger to doxy to make it easier to use. Added new nasm Doxygen function block document snippet.
1 parent c1df49d commit 6a5f130

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# -*- mode: snippet -*-
2+
# contributor: Dan Pitic <[email protected]>
3+
# name: Function Doxygen Doc
4+
# key: doxy
5+
# group: doxygen
6+
# --
7+
/**
8+
* @brief ${1:function description}
9+
*
10+
* @details ${2:detailed description}
11+
*
12+
* @param ${3:param}
13+
*
14+
* @return ${4:return type}
15+
*/

snippets/nasm-mode/function_doc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# -*- mode: snippet -*-
2+
#name : Assembly Function Doc
3+
#key : doxy
4+
#group : doxygen
5+
#contributor : Dan Pitic <[email protected]>
6+
# --
7+
;;
8+
;; @brief ${1:function description}
9+
;;
10+
;; @details ${2:detailed description}
11+
;;
12+
;; @param ${3:param}
13+
;;
14+
;; @return ${4:return}
15+
;;

0 commit comments

Comments
 (0)