Skip to content

Commit 84c07e4

Browse files
author
Axel Martin
committed
mod: reformating README.md
1 parent 378f20b commit 84c07e4

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,13 @@ Simply create a directory `plugin/doxygen` in your vim configuration folder
1111

1212
There're some configuration variables for Doxygen module. Here is a listing
1313
of the most importants :
14+
1415
- `g:DefaultAuthor` : this variable allow you to overpass the input
1516
"Enter author name : " when you use any doxygen generation.
17+
1618
- `g:DefaultVersion` : tthis variable allow you to overpass the input
1719
"Enter version string : " when you use any doxygen generation.
20+
1821
- `g:Doxygen_maxFunctionProtoLines` : if you have some function with
1922
a definition of more than 10 lines, you can change this parameter.
2023

@@ -27,15 +30,25 @@ if you want to change the tag `param` (basicly "@param "), you can define
2730
the variable `let g:Doxygen_paramTag = "/myTagParam "`.
2831

2932
Here is the listing of tags :
33+
3034
- `g:Doxygen_briefTag` : "@brief "
35+
3136
- `g:Doxygen_templateParamTag` : "@tparam "
37+
3238
- `g:Doxygen_paramTag` : "@param "
39+
3340
- `g:Doxygen_returnTag` : "@return "
41+
3442
- `g:Doxygen_throwTag` : "@throw "
43+
3544
- `g:Doxygen_fileTag` : "@file "
45+
3646
- `g:Doxygen_dateTag` : "@date "
47+
3748
- `g:Doxygen_versionTag` : "@version "
49+
3850
- `g:Doxygen_nameTag` : "@name "
51+
3952
- `g:Doxygen_classTag` : "@class "
4053

4154

0 commit comments

Comments
 (0)