File: pretty.settings

package info (click to toggle)
mockobjects 0.09-7
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,804 kB
  • sloc: java: 18,051; xml: 363; sh: 32; python: 27; makefile: 8
file content (553 lines) | stat: -rw-r--r-- 16,060 bytes parent folder | download | duplicates (7)
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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
#  Pretty.settings
version=1.0
#  This is the number of spaces to indent for each block.
#  Twice this number is the amount of space used for
#  unexpected carrage returns.
indent=4
indent.char=space

#  Style for { and }
#  C style means that { is at the end of the line
#  and } is on a line by itself.  For example,
#  if (myTest) {
#    //  This is c style
#  }
#
#  PASCAL style means both { and } are on lines
#  by themselves.  For example,
#  if (myTest)
#  {
#    //  This is PASCAL style
#  }
block.style=C

#  The following parameter should be changed to true if you
#  like your parens to have a space before and after them
#  if ( x == y )    //expr.space=true
#  if (x == y)      //expr.space=false
expr.space=false

#  The following parameter is the minimum number of blank lines
#  between methods, nested classes, and nested interfaces.
#  It is also the number of lines before and after
#  field declarations, though field declarations will have
#  what ever spacing you used.
#
#  Note that this is a minimum.  If your code already
#  has more space between methods, then it won't shrink
#  the number of blank lines.
lines.between=1


#
#  Default Javadoc comments
#
#  The following items are used by the mechanism that
#  automatically inserts javadoc comments.  Other than
#  author (which I recommend that you change), these
#  values are probably sufficient.  However, if you
#  want to make it easer to search your files to find
#  where the values are missing, you can change these
#  to something more unique.
#

#  Author - the default author
author=<a href="mailto:vmassol@apache.org">Vincent Massol</a>

#  Default description of the class
class.descr=Description of the Class

#  Default description of the interface
interface.descr=Description of the Interface

#  Default description of the constructor  {0} stands for the name
#  of the constructor
constructor.descr=Constructor for the {0} object

#  Default description of the method
method.descr=Description of the Method

#  Default description of the parameter
param.descr=Description of Parameter

#  Default description of the return value
return.descr=Description of the Returned Value

#  Default description of the exception
exception.descr=Description of Exception

#  Pretty.settings
version=1.1
#  Default description of the getter.  {0} is the name of the
#  attribute, {1} is the name of the class, {2} is 'class'
#  or 'object' depending on whether it is static or not
getter.descr=Gets the {0} attribute of the {1} {2}

#  Default description of the setter.  {0} is the name of the
#  attribute, {1} is the name of the class, {2} is 'class'
#  or 'object' depending on whether it is static or not
setter.descr=Sets the {0} attribute of the {1} {2}

#  Parameter description for setters.  {0} is the name of the attribute
setter.param.descr=The new {0} value

#  Return description for getters.  {0} is the name of the attribute
getter.return.descr=The {0} value

#
#  Sort order
#
#  To change the relative priorities of the sort, adjust the number after
#  the dot.  For instance, if you want all the instance parts first then
#  static parts second, and within these you want the field, constructor etc
#  to be sorted next, switch the number of sort.1 and sort.2.


#  Check the type first
#    This places the fields first, and initializers last.  Note that to keep
#    things compiling initializers must be after the fields.
sort.1=Type(Field,Initializer,Constructor,Method,NestedClass,NestedInterface)

#  Check the class/instance next
#    To place the static methods and variables first, switch the order
#    of instance and static.
sort.2=Class(Instance,Static)

#  Check the protection next
#    To sort with public methods/variables use Protection(public)
#    To sort with private methods/variables use Protection(private)
sort.3=Protection(public)

#  Group setters and getters last
#    Setters are methods that start with the word 'set'
#    Getters are methods that start with the word 'get' or 'is'
sort.4=Method(setter,getter,other)

#  Pretty.settings
version=1.2

#  Limits the level that javadoc comments are forced
#  into the document.  The following are valid
#  levels:
#  *  all - all items must have javadoc
#  *  private - same as all
#  *  package - all items except private items must have javadoc
#  *  default - same as package
#  *  protected - protected and public items must have javadoc
#  *  public - only public items must have javadoc
#  *  none - nothing is required to have javadoc
#
#  method.minimum applies to constructors and methods
method.minimum=none

#  field.minimum applies to fields
field.minimum=none

#  Default field description
field.descr=Description of the Field

#  Default description of the run method.  {0} is the name of the
#  attribute, {1} is the name of the class, {2} is 'class'
#  or 'object' depending on whether it is static or not
run.descr=Main processing method for the {1} {2}


#  Default description of the run method.  {0} is the name of the
#  attribute, {1} is the name of the class, {2} is 'class'
#  or 'object' depending on whether it is static or not
main.descr=The main program for the {1} {2}

#  Description of the main arguments
main.param.descr=The command line arguments

#  Is the date a required field of the class or interface
date.required=false

#  Pretty.settings
version=1.3

#  Default description of the add method.  {0} is the name of the
#  attribute, {1} is the name of the class, {2} is 'class'
#  or 'object' depending on whether it is static or not
adder.descr=Adds a feature to the {0} attribute of the {1} {2}

#  Description of the add argument
adder.param.descr=The feature to be added to the {0} attribute




#  Pretty Printer Version
version=1.4
#  JUnit has a particular format for the names of methods.
#  These setup for the unit tests are done in a method named
#  setUp, the cleanup afterwards is done in tearDown, and
#  the unit tests all start with the word test.  The following
#  are the default descriptions of these methods.
junit.setUp.descr=The JUnit setup method

junit.test.descr=A unit test for JUnit

junit.tearDown.descr=The teardown method for JUnit

junit.suite.descr=A suite of unit tests for JUnit
junit.suite.return.descr=The test suite

#  class.minimum applies to classes and interfaces
class.minimum=none



#  Pretty Printer Version
version=1.5

#  Is there a space after the cast
cast.space=false

#  Star count for javadoc
javadoc.star=2

#  Wordwrap length for javadoc.  You must have at least
#  javadoc.wordwrap.min characters in the comment and you
#  must be passing javadoc.wordwrapp.max for the indenting
#  plus the comment
javadoc.wordwrap.max=78
javadoc.wordwrap.min=40

#  Pretty Printer Version
version=1.6

#
#  Header:
#  Uncomment these lines if you would like
#  a standard header at the beginning of each file.
#  You are allowed an unlimited number of lines here,
#  just number them sequentially.
#
header.1=/*
header.2= * The Apache Software License, Version 1.1
header.3= *
header.4= * Copyright (c) 1999 The Apache Software Foundation.  All rights
header.5= * reserved.
header.6= *
header.7= * Redistribution and use in source and binary forms, with or without
header.8= * modification, are permitted provided that the following conditions
header.9= * are met:
header.10= *
header.11= * 1. Redistributions of source code must retain the above copyright
header.12= *    notice, this list of conditions and the following disclaimer.
header.13= *
header.14= * 2. Redistributions in binary form must reproduce the above copyright
header.15= *    notice, this list of conditions and the following disclaimer in
header.16= *    the documentation and/or other materials provided with the
header.17= *    distribution.
header.18= *
header.19= * 3. The end-user documentation included with the redistribution, if
header.20= *    any, must include the following acknowlegement:
header.21= *       "This product includes software developed by the
header.22= *        Apache Software Foundation (http://www.apache.org/)."
header.23= *    Alternately, this acknowlegement may appear in the software itself,
header.24= *    if and wherever such third-party acknowlegements normally appear.
header.25= *
header.26= * 4. The names "The Jakarta Project", "Ant", and "Apache Software
header.27= *    Foundation" must not be used to endorse or promote products derived
header.28= *    from this software without prior written permission. For written
header.29= *    permission, please contact apache@apache.org.
header.30= *
header.31= * 5. Products derived from this software may not be called "Apache"
header.32= *    nor may "Apache" appear in their names without prior written
header.33= *    permission of the Apache Group.
header.34= *
header.35= * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
header.36= * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
header.37= * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
header.38= * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
header.39= * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
header.40= * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
header.41= * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
header.42= * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
header.43= * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
header.44= * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
header.45= * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
header.46= * SUCH DAMAGE.
header.47= * ====================================================================
header.48= *
header.49= * This software consists of voluntary contributions made by many
header.50= * individuals on behalf of the Apache Software Foundation.  For more
header.51= * information on the Apache Software Foundation, please see
header.52= * <http://www.apache.org/>.
header.53= */


#  Pretty Printer Version
version=1.7
#  The following allow you to require and order
#  tags for the classes, methods, and fields.  To
#  require the tag, add the name of the tag here
#  and then add a TAGNAME.descr field.  To only
#  specify the order, just include the tag here.

#  Here is the order for tags for classes and interfaces
class.tags=author

#  Here is the order for tags for methods and constructors
method.tags=param,return,exception,since

#  Here is the order for tags for fields
field.tags=since

#  In all tags that are required, there are some parameters
#  that are available.  These are:
#  {0} refers to the current user
#  {1} refers to the current user
#  {2} refers to the name of the current object

#  Now we are ready to specify the author
author.descr=<a href="mailto:vmassol@apache.org">Vincent Massol</a>

#  Now we are ready to specify the created tag
created.descr={1}


#  Pretty Printer Version
version=2.2

#  Whether we put a space before the @
space.before.javadoc=true

#  Should we sort the types and imports?
sort.top=false

#  Should catch statements look like
#  (true) is:
#  try {
#      //  Something here
#  }
#  catch (IOException ioe) {
#      //  Something here
#  }
#  (false) is:
#  try {
#      //  Something here
#  } catch (IOException ioe) {
#      //  Something here
#  }
#  This value is also used for else statements
catch.start.line=false

#  This determines if there should be a space after keywords
#  When this value is true, you get:
#  if (true) {
#      //  Do something
#  }
#  When this value is false, you get:
#  if(true) {
#      //  Do something
#  }
keyword.space=true


#
#  Do you want to lineup the names and descriptions
#  in javadoc comments?
#
javadoc.id.lineup=true

#
#  How many spaces should javadoc comments be indented?
#
javadoc.indent=1

#
#  What do you do when a newline is unexpectedly encountered?
#  The valid values are double and param.  Double means that
#  you should indent twice.  Param means try to line up the
#  the parameters.
#
surprise.return=double

#
#  To handle sun's coding standard, you want the method to begin
#  with a PASCAL coding style and the {} beneath that to be C style.
#  This parameter allows you to set the method style different
#  from the rest.
#
method.block.style=PASCAL

#
#  Should throws part of a method/constructor declaration always be
#  on it's own line?
#
throws.newline=false


#  Pretty Printer Version
version=3.0


#
#  Wordwrap the javadoc comments
#
reformat.comments=true

#
#  Single line comment type
#

#
#  Should each single line comment be indented a certain number of spaces
#  from the margin?  For this to work right be sure to indent each line with
#  spaces.
#
singleline.comment.ownline=true


#
#  Indent the name of the field to this column (-1 for just one space)
#
field.name.indent=-1


#
#  Include javadoc comments where ever they appear
#
keep.all.javadoc=false


#
#  End of line character(s) - either CR, CRNL, or NL
#  CR means carriage return, NL means newline
#
end.line=CRNL

#
#  Absolute indent before a single line comment.
#
singleline.comment.absoluteindent=0

#
#  Space used before the start of a single line 
#  from the end of the code
#
singleline.comment.incrementalindent=0

#
#  This feature describes how the pretty printer should 
#  indent single line comments (//) that share the line
#  with source code.  The two choices are incremental and absolute.
#    incremental  -  use an incremental indent
#    absolute  -  use the absolute indent level
#
singleline.comment.indentstyle.shared=incremental

#
#  This feature describes how the pretty printer should
#  indent single line comments (//) that are on their
#  own line.  The two choices are code and absolute.
#    code  -  use the same indent as the current code
#    absolute  -  use the absolute indent level
#
singleline.comment.indentstyle.ownline=code

#
#  This feature describes what type of characters are used for
#  the java files.
#    1 - ASCII (1 byte characters)
#    2 - Unicode (2 byte characters - far east)
#
char.stream.type=1

#
#  This features sprecifies how to space out a field or a local
#  variable declaration.
#    single - a space between the modifiers, the type, the name 
#        and the initializer
#    dynamic - determine the spacing between the modifiers, type, 
#        name, and initializers so everything lines up
#
variable.spacing=single


#  Pretty Printer Version
version=3.1

#
#  When a dynamic field spacing is used, this value specifies
#  the number of additional spaces to add between the modifiers, 
#  type, name, and initializer.
#
dynamic.variable.spacing=1


#  Pretty Printer Version
version=3.2

#
#  How to format C Style comments.  Valid values are:
#    leave - leave alone
#    align.star - place a row of stars to the right and align on those
#    align.blank - just align the comments to the right (no star)
#
c.style.format=align.star

#
#  For one of the methods above that use the align type, this is
#  the number of spaces to include after the * or blank
#
c.style.indent=2


#  Pretty Printer Version
version=3.3

#
#  Empty methods and constructors remain on a single line
#
empty.block.single.line=false


#  Pretty Printer Version
version=3.4

#
#  Do we force a space after a cast?
#
cast.force.nospace=false


#  Pretty Printer Version
version=3.5

#
#  What tag name should be used for exceptions
#
exception.tag.name=@exception


#  Pretty Printer Version
version=3.6

#
#  Should inner classes be documented
#
document.nested.classes=true

#
#  Should the document have a footer.  Include it here.
#  To include more lines, just add more values
#
#footer.1=
#footer.2=//  This is the end of the file
#footer.3=

#  Pretty Printer Version
version=3.7

#
#  Should the local variables be aligned with the { and }
#  or should they be indented to align with the other code?
#  false means align with the code, true means align
#  with the { }
#
variable.align.with.block=false