-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.doxygensupport
174 lines (125 loc) · 6.81 KB
/
README.doxygensupport
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
README for doxygen-support.vim (Version 2.2) / March 5 2011
* INSTALLATION
* RELEASE NOTES
* FILES
This plugin generates Ex commands and a menu (or a menu tree) from a template
file containing user defined comment templates to be used for source code
documentation with Doxygen. The template file can have user defined macros and
can include other files.
=======================================================================================
INSTALLATION
=======================================================================================
(1) LINUX
----------
The subdirectories in the zip archive doxygen-support.zip mirror the
directory structure which is needed below the local installation directory
$HOME/.vim/ (find the value of $HOME with ":echo $HOME" from inside Vim).
(1.0) Save the template files in '$HOME/.vim/doxygen-support/templates/'
if you have changed any of them.
(1.1) Copy the zip archive doxygen-support.zip to $HOME/.vim and run
unzip doxygen-support.zip
If you have already an older version of doxygen-support and you have modified
the template files you may want to save your templates first and suppress
overwriting them with
unzip doxygen-support.zip -x *.templates
(1.2) Loading of plugin files must be enabled. If not use
:filetype plugin on
(1.3) Set at least some personal details in the file
'$HOME/.vim/doxygen-support/templates/doxygen.templates'
Here is the minimal personalization (my settings as an example):
$AUTHOR$ = Dr. Fritz Mehner
$AUTHORREF$ = fgm
$EMAIL$ = [email protected]
$COMPANY$ = FH Südwestfalen, Iserlohn
$COPYRIGHT$ = Copyright (c) $YEAR$, $AUTHOR$
(Read more about the template system in the plugin documentation)
(2) WINDOWS
------------
The subdirectories in the zip archive doxygen-support.zip mirror the
directory structure which is needed below the local installation directory
$HOME/vimfiles/ (find the value of $HOME with ":echo $HOME" from inside Vim).
(2.0) Save the template files in '$HOME/vimfiles/doxygen-support/templates/' if
you have changed any of them.
(2.1) Copy the zip archive doxygen-support.zip to $HOME/vimfiles and run
unzip doxygen-support.zip
If you have already an older version of doxygen-support and you have modified
the template files you may want to save your templates first and suppress
overwriting them with
unzip doxygen-support.zip -x *.templates
(2.2) Loading of plugin files must be enabled. If not use
:filetype plugin on
(2.3) Set at least some personal details in the file
'$HOME/vimfiles/doxygen-support/templates/doxygen.templates'
Here is the minimal personalization (my settings as an example):
$AUTHOR$ = Dr. Fritz Mehner
$AUTHORREF$ = fgm
$EMAIL$ = [email protected]
$COMPANY$ = FH Südwestfalen, Iserlohn
$COPYRIGHT$ = Copyright (c) $YEAR$, $AUTHOR$
(Read more about the template system in the plugin documentation)
Restart gVim/Vim generate the help tags
:helptags ~/.vim/doc
and look at doxygen-support help with
:help doxygen-support
or use the 'help' item in the root menu of this plug-in.
=======================================================================================
RELEASE NOTES
=======================================================================================
---------------------------------------------------------------------------------------
RELEASE NOTES FOR VERSION 2.2
---------------------------------------------------------------------------------------
- New main menu iten: "help (Doxygen-Support)"
- Bugfix: detection of a systemwide installation can fail.
---------------------------------------------------------------------------------------
RELEASE NOTES FOR VERSION 2.1
---------------------------------------------------------------------------------------
- completely new doxygen integration
- new ex-commands
---------------------------------------------------------------------------------------
RELEASE NOTES FOR VERSION 2.0.2
---------------------------------------------------------------------------------------
- Windows: Missing variable from 2.0.1 was still wrong.
- Bugfix: variable g:Doxy_LoadMenus had no effect.
- Documentation corrected.
---------------------------------------------------------------------------------------
RELEASE NOTES FOR VERSION 2.0.1
---------------------------------------------------------------------------------------
- Windows: Missing variable prevents correct plugin loading (thanks to Martin Banszel)
- Documentation corrected.
---------------------------------------------------------------------------------------
RELEASE NOTES FOR VERSION 2.0
---------------------------------------------------------------------------------------
- Systemwide installation now possible.
- Visual mode insert (surround a marked region).
- Dialog to ask for parameters possible.
- Automatic generation of submenu titles.
---------------------------------------------------------------------------------------
RELEASE NOTES FOR VERSION 1.4
---------------------------------------------------------------------------------------
- Templates can contain preprocessor statements.
---------------------------------------------------------------------------------------
RELEASE NOTES FOR VERSION 1.3
---------------------------------------------------------------------------------------
- Include mechanism for template files.
- Menu items can be sorted/unsorted.
---------------------------------------------------------------------------------------
RELEASE NOTES FOR VERSION 1.2
---------------------------------------------------------------------------------------
- New 'insert' attribute for templates.
---------------------------------------------------------------------------------------
RELEASE NOTES FOR VERSION 1.1
---------------------------------------------------------------------------------------
- New template attributes allow insertion above and below the current line and
appending to the current line.
---------------------------------------------------------------------------------------
RELEASE NOTES FOR VERSION 1.0
---------------------------------------------------------------------------------------
- Initial upload
=======================================================================================
FILES
=======================================================================================
doc/doxygensupport.txt The help file for the local online help.
doxygen-support/templates/* The template files (examples).
plugin/doxygen-support.vim The doxygen plugin for Vim/gVim.
README.doxygensupport This file.
=======================================================================================