-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathjautodoc_preferences.xml
364 lines (364 loc) · 14.4 KB
/
jautodoc_preferences.xml
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<jautodoc-preferences>
<options>
<completeExistingJavadoc>true</completeExistingJavadoc>
<keepExistingJavadoc>false</keepExistingJavadoc>
<replaceExistingJavadoc>false</replaceExistingJavadoc>
<includePublic>true</includePublic>
<includeProtected>false</includeProtected>
<includePackage>true</includePackage>
<includePrivate>false</includePrivate>
<includeTypes>false</includeTypes>
<includeFields>false</includeFields>
<includeMethods>true</includeMethods>
<getterSetterOnly>false</getterSetterOnly>
<excludeGetterSetter>true</excludeGetterSetter>
<excludeOverriding>true</excludeOverriding>
<addTodoForAutodoc>false</addTodoForAutodoc>
<createDummyComment>true</createDummyComment>
<singleLineComment>true</singleLineComment>
<useEclipseFormatter>true</useEclipseFormatter>
<getterSetterFromField>false</getterSetterFromField>
<includeSubPackages>false</includeSubPackages>
<getterSetterFromFieldFirst>true</getterSetterFromFieldFirst>
<getterSetterFromFieldReplace>false</getterSetterFromFieldReplace>
<addHeader>true</addHeader>
<replaceHeader>false</replaceHeader>
<multiCommentHeader>false</multiCommentHeader>
<usePackageInfo>false</usePackageInfo>
</options>
<getSetFromFieldReplacements>
<getSetFromFieldReplacement>
<fieldPrefix>The</fieldPrefix>
<returnPrefix>the</returnPrefix>
<parameterPrefix>the new</parameterPrefix>
</getSetFromFieldReplacement>
<getSetFromFieldReplacement>
<fieldPrefix></fieldPrefix>
<returnPrefix>the</returnPrefix>
<parameterPrefix>the new</parameterPrefix>
</getSetFromFieldReplacement>
</getSetFromFieldReplacements>
<tagOrders>
<tagOrder>@author</tagOrder>
<tagOrder>@version</tagOrder>
<tagOrder>@param</tagOrder>
<tagOrder>@return</tagOrder>
<tagOrder>@throws</tagOrder>
<tagOrder>@see</tagOrder>
<tagOrder>@since</tagOrder>
<tagOrder>@serial</tagOrder>
<tagOrder>@serialField</tagOrder>
<tagOrder>@serialData</tagOrder>
<tagOrder>@deprecated</tagOrder>
</tagOrders>
<properties/>
<replacements>
<replacement mode="0" scope="1" shortcut="get">Gets the</replacement>
<replacement mode="0" scope="1" shortcut="set">Sets the</replacement>
<replacement mode="0" scope="1" shortcut="add">Adds the</replacement>
<replacement mode="0" scope="1" shortcut="edit">Edits the</replacement>
<replacement mode="0" scope="1" shortcut="remove">Removes the</replacement>
<replacement mode="0" scope="1" shortcut="init">Inits the</replacement>
<replacement mode="0" scope="1" shortcut="parse">Parses the</replacement>
<replacement mode="0" scope="1" shortcut="create">Creates the</replacement>
<replacement mode="0" scope="1" shortcut="build">Builds the</replacement>
<replacement mode="0" scope="1" shortcut="is">Checks if is</replacement>
<replacement mode="0" scope="1" shortcut="print">Prints the</replacement>
<replacement mode="0" scope="1" shortcut="has">Checks for</replacement>
</replacements>
<templates>
<typeTemplate name="Type.Factory" useSignature="false" defaultTemplate="false" kind="1">
<regex>(.+)Factory</regex>
<example>MessageFactory</example>
<text>/**
* A factory for creating ${e.g(1)} objects.
*/</text>
<childTemplates>
<methodTemplate name="Type.Factory.Method.create" useSignature="false" defaultTemplate="false" kind="3">
<regex>create(.+)</regex>
<example>createMessage</example>
<text>/**
* Creates a new ${e.p().g(1)} object.
*/</text>
<childTemplates/>
</methodTemplate>
</childTemplates>
</typeTemplate>
<typeTemplate name="Type.Observer" useSignature="false" defaultTemplate="false" kind="1">
<regex>(.+)Observer</regex>
<example>ImageObserver</example>
<text>/**
* An asynchronous update interface for receiving notifications
* about ${e.g(1)} information as the ${e.g(1)} is constructed.
*/</text>
<childTemplates>
<methodTemplate name="Type.Observer.Method.update" useSignature="false" defaultTemplate="false" kind="3">
<regex>.*</regex>
<example>imageUpdate</example>
<text>/**
* This method is called when information about an ${e.p().g(1)}
* which was previously requested using an asynchronous
* interface becomes available.
*/</text>
<childTemplates/>
</methodTemplate>
</childTemplates>
</typeTemplate>
<typeTemplate name="Type.Listener" useSignature="false" defaultTemplate="false" kind="1">
<regex>(.+)Listener</regex>
<example>AutodocListener</example>
<text>/**
* The listener interface for receiving ${e.g(1).fl()} events.
* The class that is interested in processing a ${e.g(1).fl()}
* event implements this interface, and the object created
* with that class is registered with a component using the
* component's <code>add${e.g(1)}Listener<code> method. When
* the ${e.g(1).fl()} event occurs, that object's appropriate
* method is invoked.
*
* @see ${e.g(1)}Event
*/</text>
<childTemplates>
<methodTemplate name="Type.Listener.Method.created" useSignature="false" defaultTemplate="false" kind="3">
<regex>(.*)Created</regex>
<example>autodocCreated</example>
<text>/**
* Invoked when ${e.g(1).rs()} is created.
*/</text>
<childTemplates/>
</methodTemplate>
<methodTemplate name="Type.Listener.Method.updated" useSignature="false" defaultTemplate="false" kind="3">
<regex>(.*)Updated</regex>
<example>autodocUpdated</example>
<text>/**
* Invoked when ${e.g(1).rs()} update occurs.
*/</text>
<childTemplates/>
</methodTemplate>
</childTemplates>
</typeTemplate>
<typeTemplate name="Type.Default" useSignature="false" defaultTemplate="true" kind="1">
<regex>.+</regex>
<example>ExampleType</example>
<text>/**
## type: class|interface|enum
* The ${e.getType().fu()} ${e}.
*/</text>
<childTemplates/>
</typeTemplate>
<fieldTemplate name="Field.fPrefix" useSignature="false" defaultTemplate="false" kind="2">
<regex>f([A-Z].+)</regex>
<example>fExampleMember</example>
<text>/**
* The ${e.g(1).rsfl()}.
*/</text>
<childTemplates/>
</fieldTemplate>
<fieldTemplate name="Field.thePrefix" useSignature="false" defaultTemplate="false" kind="2">
<regex>the[A-Z].+</regex>
<example>theNumberOfQuestions</example>
<text>/**
* ${e.rsfu()}.
*/</text>
<childTemplates/>
</fieldTemplate>
<fieldTemplate name="Field.Default" useSignature="false" defaultTemplate="true" kind="2">
<regex>.+</regex>
<example>numberOfQuestions</example>
<text>/**
#if(${e.isStatic()} && ${e.isFinal()})
* The Constant ${e}.
#else
* The ${e.rs()}.
#end
*/</text>
<childTemplates/>
</fieldTemplate>
<methodTemplate name="Method.getInstance" useSignature="false" defaultTemplate="false" kind="3">
<regex>getInstance</regex>
<example>getInstance</example>
<text>/**
* Gets the single instance of ${e.getDeclaringType()}.
*
* @return single instance of ${e.getDeclaringType()}
*/</text>
<childTemplates/>
</methodTemplate>
<methodTemplate name="Method.Getter" useSignature="true" defaultTemplate="false" kind="3">
<regex>\S+ get(\S+)\(.*\)</regex>
<example>int getNumberOfQuestions()</example>
<text>/**
* Gets the ${e.g(1).rsfl()}.
*
* @return the ${e.g(1).rsfl()}
*/</text>
<childTemplates/>
</methodTemplate>
<methodTemplate name="Method.Setter" useSignature="true" defaultTemplate="false" kind="3">
<regex>void set(\S+)\([^,]+ ([^,]+)\)</regex>
<example>void setNumberOfQuestions(int number)</example>
<text>/**
* Sets the ${e.g(1).rsfl()}.
*
* @param ${e.g(2)} the new ${e.g(1).rsfl()}
*/</text>
<childTemplates/>
</methodTemplate>
<methodTemplate name="Method.boolean Getter" useSignature="true" defaultTemplate="false" kind="3">
<regex>boolean is(.+)\(.*\)</regex>
<example>boolean isBlue()</example>
<text>/**
* Checks if is ${e.g(1).rsfl()}.
*
* @return true, if is ${e.g(1).rsfl()}
*/</text>
<childTemplates/>
</methodTemplate>
<methodTemplate name="Method.Main-Method" useSignature="true" defaultTemplate="false" kind="3">
<regex>void main\(String\[\] (\S+)\)</regex>
<example>void main(String[] args)</example>
<text>/**
* The main method.
*
* @param ${e.g(1)} the arguments
*/</text>
<childTemplates/>
</methodTemplate>
<methodTemplate name="Method.Constructor" useSignature="true" defaultTemplate="false" kind="3">
<regex>(\S+)\(.*\)</regex>
<example>SimpleClass()</example>
<text>/**
* Instantiates a new ${e.g(1).rsfl()}.
*/</text>
<childTemplates/>
</methodTemplate>
<methodTemplate name="Method.Returns void" useSignature="true" defaultTemplate="false" kind="3">
<regex>void (.+)\(.*\)</regex>
<example>void doSomething()</example>
<text>/**
* ${e.g(1).rsfu()}.
*/</text>
<childTemplates/>
</methodTemplate>
<methodTemplate name="Method.Returns boolean" useSignature="true" defaultTemplate="false" kind="3">
<regex>boolean (\S+)\(.*\)</regex>
<example>boolean doSomething(int parameter)</example>
<text>/**
* ${e.g(1).rsfu()}.
*
* @return true, if successful
*/</text>
<childTemplates/>
</methodTemplate>
<methodTemplate name="Method.Returns other" useSignature="true" defaultTemplate="false" kind="3">
<regex>(\S+) (\S+)\(.*\)</regex>
<example>ReturnValue calculateSomething()</example>
<text>/**
* ${e.g(2).rsfu()}.
*
* @return the ${e.g(1).rsfl()}
*/</text>
<childTemplates/>
</methodTemplate>
<methodTemplate name="Method.Default" useSignature="false" defaultTemplate="true" kind="3">
<regex>.+</regex>
<example>doSomething</example>
<text>/**
## Actually this is not used, because there
## are templates for different return types
* ${e.rsfu()}.
*/</text>
<childTemplates/>
</methodTemplate>
<parameterTemplate name="Parameter.Generic Type Parameter" useSignature="false" defaultTemplate="false" kind="4">
<regex><(.+)></regex>
<example><E></example>
<text>/**
#if(${e.g(1)} == 'E')
* @param ${e} the element type
#elseif(${e.g(1)} == 'K')
* @param ${e} the key type
#elseif(${e.g(1)} == 'N')
* @param ${e} the number type
#elseif(${e.g(1)} == 'V')
* @param ${e} the value type
#else
* @param ${e} the generic type
#end
*/</text>
<childTemplates/>
</parameterTemplate>
<parameterTemplate name="Parameter.compUnit" useSignature="false" defaultTemplate="false" kind="4">
<regex>compUnit</regex>
<example>compUnit</example>
<text>/**
## Example for shortcuts
* @param ${e} the compilation unit
*/</text>
<childTemplates/>
</parameterTemplate>
<parameterTemplate name="Parameter.pPrefix" useSignature="false" defaultTemplate="false" kind="4">
<regex>p([A-Z].+)</regex>
<example>pField</example>
<text>/**
* @param ${e} the ${e.g(1).rsfl()}
*/</text>
<childTemplates/>
</parameterTemplate>
<parameterTemplate name="Parameter.Default" useSignature="false" defaultTemplate="true" kind="4">
<regex>.+</regex>
<example>simpleParameter</example>
<text>/**
* @param ${e} the ${e.rsfl()}
*/</text>
<childTemplates/>
</parameterTemplate>
<exceptionTemplate name="Exception.IOException" useSignature="false" defaultTemplate="false" kind="5">
<regex>IOException</regex>
<example>IOException</example>
<text>/**
* @throws ${e} Signals that an I/O exception has occurred.
*/</text>
<childTemplates/>
</exceptionTemplate>
<exceptionTemplate name="Exception.Default" useSignature="false" defaultTemplate="true" kind="5">
<regex>.+</regex>
<example>ExampleException</example>
<text>/**
* @throws ${e} the ${e.sfl()}
*/</text>
<childTemplates/>
</exceptionTemplate>
</templates>
<headerText>/**************************************************************************
* <pre>
*
* Copyright (c) Unterrainer Informatik OG.
* This source is subject to the Microsoft Public License.
*
* See http://www.microsoft.com/opensource/licenses.mspx#Ms-PL.
* All other rights reserved.
*
* (In other words you may copy, use, change and redistribute it without
* any restrictions except for not suing me because it broke something.)
*
* THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY
* KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR
* PURPOSE.
*
* </pre>
***************************************************************************/</headerText>
<packageDocText><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head></head>
<body>
Provides...
</body>
</html></packageDocText>
<packageInfoText>/**
* Provides...
*/
package ${package_name};</packageInfoText>
</jautodoc-preferences>