Skip to content

Commit b93f673

Browse files
Mathias Lorentevim-scripts
authored andcommitted
Version 0.2.3
Added @Version tag into the DocBlock generated by DoxygenAuthorFunc() (thanks to Dave Walter).
1 parent 7ea7295 commit b93f673

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

plugin/DoxygenToolkit.vim

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
11
" DoxygenToolkit.vim
22
" Brief: Usefull tools for Doxygen (comment, author, license).
3-
" Version: 0.2.2
4-
" Date: 01/20/08
3+
" Version: 0.2.3
4+
" Date: 03/26/09
55
" Author: Mathias Lorente
66
"
77
" TODO: add automatically (option controlled) in/in out flags to function
88
" parameters
9+
" TODO: (Python) Check default paramareters defined as list/dictionnary/tuple
10+
"
11+
" Note: Added @version tag into the DocBlock generated by DoxygenAuthorFunc()
12+
" (thanks to Dave Walter).
13+
" The version string can be defines into your .vimrc file with
14+
" g:DoxygenToolkit_versionString or it will be asked the first time the
15+
" function is called (same behavior as @author tag). Example:
16+
" /// \file foo.cpp
17+
" /// \brief
18+
" /// \author Dave Walter
19+
" /// \version 1.0
20+
" /// \date 2009-03-26
921
"
1022
" Note: Comments are now allowed in function declaration. Example:
1123
" - C/C++: void func( int foo, // first param
@@ -253,6 +265,9 @@ endif
253265
if !exists("g:DoxygenToolkit_dateTag")
254266
let g:DoxygenToolkit_dateTag = "@date "
255267
endif
268+
if !exists("g:DoxygenToolkit_versionTag")
269+
let g:DoxygenToolkit_versionTag = "@version "
270+
endif
256271
if !exists("g:DoxygenToolkit_undocTag")
257272
let g:DoxygenToolkit_undocTag = "DOX_SKIP_BLOCK"
258273
endif
@@ -397,6 +412,11 @@ function! <SID>DoxygenAuthorFunc()
397412
let g:DoxygenToolkit_authorName = input("Enter name of the author (generally yours...) : ")
398413
endif
399414

415+
" Test versionString variable
416+
if !exists("g:DoxygenToolkit_versionString")
417+
let g:DoxygenToolkit_versionString = input("Enter version string : ")
418+
endif
419+
400420
" Get file name
401421
let l:fileName = expand('%:t')
402422

@@ -406,6 +426,7 @@ function! <SID>DoxygenAuthorFunc()
406426
exec "normal o".s:interCommentTag.g:DoxygenToolkit_briefTag_pre
407427
mark d
408428
exec "normal o".s:interCommentTag.g:DoxygenToolkit_authorTag.g:DoxygenToolkit_authorName
429+
exec "normal o".s:interCommentTag.g:DoxygenToolkit_versionTag.g:DoxygenToolkit_versionString
409430
let l:date = strftime("%Y-%m-%d")
410431
exec "normal o".s:interCommentTag.g:DoxygenToolkit_dateTag.l:date
411432
if ( g:DoxygenToolkit_endCommentTag != "" )

0 commit comments

Comments
 (0)