User: rinkrank Date: 02/04/18 12:05:47 Modified: etc/.Refactory pretty.settings Log: same formatting as xdoclet and xjavadoc (no BEKK header) and CVS ignore build folder Revision Changes Path 1.2 +380 -310 xdocletgui/etc/.Refactory/pretty.settings Index: pretty.settings =================================================================== RCS file: /cvsroot/xdoclet/xdocletgui/etc/.Refactory/pretty.settings,v retrieving revision 1.1 retrieving revision 1.2 diff -u -w -r1.1 -r1.2 --- pretty.settings 25 Jan 2002 00:45:07 -0000 1.1 +++ pretty.settings 18 Apr 2002 19:05:47 -0000 1.2 @@ -1,174 +1,239 @@ +# Version +version=3.8 -# Pretty Printer Version -version=2.8 - -# Pretty.settings +# +# 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= * Copyright (c) 2001,2002 The XDoclet team +header.3= * All rights reserved. +header.4= */ -# This is the number of spaces to indent for each block. -# Twice this number is the amount of space used for -# unexpected carrage returns. Use the word "tab" for tabs -# and the word "space" for spaces. +# This is the number of characters to indent for each block. indent=1 -indent.char=tab -# 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 +# This is the number of characters to indent for each block. +# The character used to indent each block +# * tab - use tabs to indent +# * space - use spaces to indent +indent.char=tab # 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 +expr.space=true # 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=2 - - -# -# Default Javadoc comments -# -# The following items are used by the mechanism that -# automatically inserts javadoc comments. 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. -# +lines.between=0 -# Default description of the class -class.descr=Describe what this class does \n @todo-javadoc Write javadocs +# Is there a space after the cast +cast.space=true -# Default description of the interface -interface.descr=Describe what this class does \n @todo-javadoc Write javadocs for interface +# Do we force a space after a cast? +cast.force.nospace=false -# Default description of the constructor {0} stands for the name -# of the constructor -constructor.descr=Describe what the {0} constructor does \n @todo-javadoc Write javadocs for constructor +# What do you do when a newline is unexpectedly encountered? +# * double - The pretty printer inserts 2 indents +# * single - The pretty printer inserts 1 indent +# * param - Like single, except method arguments are indented to the parens +surprise.return=single -# Default description of the method -method.descr=Describe what the {0} method does \n @todo-javadoc Write javadocs for method +# Should throws part of a method/constructor declaration always be +# on its own line? +throws.newline=false -# Default description of the parameter -param.descr=Describe what the parameter does \n @todo-javadoc Write javadocs for method parameter +# When the catch.start.line setting is true, catch statements look like +# try { +# // Something here +# } +# catch (IOException ioe) { +# // Something here +# } +# When the catch.start.line setting is falserue, catch statements look like +# try { +# // Something here +# } catch (IOException ioe) { +# // Something here +# } +catch.start.line=true -# Default description of the return value -return.descr=Describe the return value \n @todo-javadoc Write javadocs for return value +# Should if/then/else statements look like +# (true) is: +# if (someTest()) { +# // Something here +# } +# else { +# // Something here +# } +# (false) is: +# if (someTest()) { +# // Something here +# } else { +# // Something here +# } +else.start.line=true -# Default description of the exception -exception.descr=Describe the exception \n @todo-javadoc Write javadocs for exception +# Indent the name of the field (instance variable or class +# variable) to this column (-1 for just one space) +field.name.indent=20 +# End of line character(s) - either CR, CRNL, or NL +# * CR - carriage return +# * NL - newline +# * CRNL - carriage return and newline +end.line=NL + +# 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 +# * javadoc.dynamic - determine the spacing between the modifiers, type, name, and initializers so everything lines up, except when the field is prefixed by a javadoc comment +# * align.equals - align the equals statements of field declaration, but nothing else +variable.spacing=single + +# 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 + +# 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 -# 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} +# The amount to indent a case statement (in terms of indent.char) +case.indent=0 -# 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} +# This determines if there should be a space after keywords +# such as if, while, or for. When this value is true, you get: +# if (true) { +# // Do something +# } +# When this value is false, you get: +# if(true) { +# // Do something +# } +keyword.space=false -# Parameter description for setters. {0} is the name of the attribute -setter.param.descr=The new {0} value +# Do we force a blank line before and after local variable declarations? +insert.space.around.local.variables=true -# Return description for getters. {0} is the name of the attribute -getter.return.descr=The {0} value +# This is the number of lines to insert after a package statement. +lines.after.package=1 -# Default field description -field.descr=@todo-javadoc Describe the field +# Do we keep all the newlines around imports? +maintain.newlines.around.imports=true -# Default description of the run method. {0} is not -# applicable, {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} +# This is the number of lines to insert before a class. +lines.before.class=0 -# Default description of the run method. {0} is not -# applicable, {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=Describe the command line arguments \n @todo-javadoc Describe the command line arguments +# 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 +# } +# EMACS style means both { and } are on lines +# by themselves and indented one level. +# For example, +# if (myTest) +# { +# // This is EMACS style +# } +# * C - C style +# * PASCAL - PASCAL style +# * EMACS - EMACS style +block.style=PASCAL +# 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. +# * C - C style +# * PASCAL - PASCAL style +# * EMACS - EMACS style +method.block.style=PASCAL +# To handle sun's coding standard, you want the class to begin +# with a PASCAL coding style and the {} beneath that to be C style. +# This parameter allows you to set the class style different +# from the rest. +# * C - C style +# * PASCAL - PASCAL style +# * EMACS - EMACS style +class.block.style=PASCAL -# 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} -adder.descr=Describe the method \n @todo-javadoc Describe the method +# Do we force if and while and for statements to have a block? { ... } +force.block=false -# Description of the add argument -#adder.param.descr=The feature to be added to the {0} attribute -adder.param.descr=The feature to be added to the {0} attribute -adder.param.descr=Describe the method parameter \n @todo-javadoc Describe the method parameter +# Empty methods and constructors remain on a single line +empty.block.single.line=false -# 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 +# Remove {} when they surround only 1 statement +remove.excess.blocks=false -junit.test.descr=A unit test for JUnit +# 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 -junit.tearDown.descr=The teardown method for JUnit +# Absolute indent before a single line comment. +singleline.comment.absoluteindent=0 -junit.suite.descr=A unit test suite for JUnit -junit.suite.return.descr=The test suite -# -# 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,Constructor,Method,NestedClass,NestedInterface,Initializer) - -# 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) +# Space used before the start of a single line +# from the end of the code. This value is used +# to determine the number of spaces and how these +# spaces are used based on the next few settings. +singleline.comment.incrementalindent=0 -# 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) +# 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 +# How to format C Style comments. Valid values are: +# * leave - leave alone +# * maintain.space.star - there is a row of stars to the right, but we maintain the spaces after it +# * 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=1 # Limits the level that javadoc comments are forced # into the document. The following are valid # levels: +# method.minimum applies to constructors and methods # * all - all items must have javadoc # * private - same as all # * package - all items except private items must have javadoc @@ -176,22 +241,28 @@ # * 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=all +method.minimum=none # field.minimum applies to fields -field.minimum=all +# * 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 +field.minimum=none # class.minimum applies to classes and interfaces +# * 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 class.minimum=all -# Is the date a required field of the class or interface -date.required=true - -# Is there a space after the cast -cast.space=false - # Star count for javadoc javadoc.star=2 @@ -200,212 +271,208 @@ # must be passing javadoc.wordwrapp.max for the indenting # plus the comment javadoc.wordwrap.max=80 + +# 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.min=40 -# -# 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= * Copyright (c) 2001, Aslak Hellesøy, BEKK Consulting -header.3= * All rights reserved. -header.4= * -header.5= * Redistribution and use in source and binary forms, with or without modification, -header.6= * are permitted provided that the following conditions are met: -header.7= * -header.8= * - Redistributions of source code must retain the above copyright notice, -header.9= * this list of conditions and the following disclaimer. -header.10= * -header.11= * - Redistributions in binary form must reproduce the above copyright -header.12= * notice, this list of conditions and the following disclaimer in the -header.13= * documentation and/or other materials provided with the distribution. -header.14= * -header.15= * - Neither the name of BEKK Consulting nor the names of its -header.16= * contributors may be used to endorse or promote products derived from -header.17= * this software without specific prior written permission. -header.18= * -header.19= * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -header.20= * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -header.21= * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -header.22= * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR -header.23= * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -header.24= * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -header.25= * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -header.26= * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -header.27= * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY -header.28= * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH -header.29= * DAMAGE. -header.30= */ -header.31= -header.32=/* -header.33= * Change log -header.34= * $Log: pretty.settings,v $ -header.34= * Revision 1.1 2002/01/25 00:45:07 rinkrank -header.34= * Initial revision -header.34= * -header.34= * -header.35= */ - -# 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. +# Whether we put a space before the @ +space.before.javadoc=true -# Here is the order for tags for classes and interfaces -class.tags=author,created +# Do you want to lineup the names and descriptions +# in javadoc comments? +javadoc.id.lineup=true -# Here is the order for tags for methods and constructors -method.tags=todo,param,return,exception,since +# How many spaces should javadoc comments be indented? +javadoc.indent=1 -# Here is the order for tags for fields -field.tags=todo,since +# Wordwrap the javadoc comments +reformat.comments=true -# 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 date -# {2} refers to the name of the current object +# What tag name should be used for exceptions +exception.tag.name=@exception -# Now we are ready to specify the author -author.descr={0} +# Should inner classes be documented +document.nested.classes=true -# Now we are ready to specify the created tag -created.descr={1} +# Are javadoc comments allowed to be a single line long +allow.singleline.javadoc=false -# Whether we put a space before the @ -space.before.javadoc=true +# Include javadoc comments where ever they appear. Javadoc comments +# were originally only allowed to occur at a few places: immediately +# before a method, immediately before a field, and immediately +# before a class or interface. Since it is also common for people +# to include the /*** pattern at the beginning of a file, this will be +# preserved as well. +# This was the case until JBuilder pressed the javadoc style comment into +# a new line of work - handling @todo tags. Suddenly it was permissible +# to include javadoc comments anywhere in the file. +# With keep.all.javadoc set to false, you get the original behavior. All +# javadoc comments that were not in the correct place were cleaned up for +# you. With this set to true, you can place the @todo tags wherever you please. +keep.all.javadoc=true -# Should we sort the types and imports? -sort.top=false +# Default description of the class +class.descr= -# 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 +# Default description of the interface +interface.descr= -# 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 +# Default description of the constructor {0} stands for the name +# of the constructor +constructor.descr= +# Default description of the param +method.param.descr= -# -# Do you want to lineup the names and descriptions -# in javadoc comments? -# -javadoc.id.lineup=false +# Default description of the method +method.descr= -# -# How many spaces should javadoc comments be indented? -# -javadoc.indent=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, +# {3} is the name of the attribute with the first letter lowercased +# {4} is the name of the attribute broken into words +getter.descr= + +# Return description for getters. {0} is the name of the attribute, +# {3} is the name of the attribute with the first letter lowercased +# {4} is the name of the attribute broken into words +getter.return.descr= -# -# 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 +# 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, +# {3} is the name of the attribute with the first letter lowercased +# {4} is the name of the attribute broken into words +setter.descr= + +# Parameter description for setters. {0} is the name of the attribute, +# {3} is the name of the attribute with the first letter lowercased +# {4} is the name of the attribute broken into words +setter.param.descr= -# -# 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=C +# Default field description +field.descr= -# -# Should throws part of a method/constructor declaration always be -# on it's own line? -# -throws.newline=false +# Default description of the run method. {0} is not +# applicable, {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 not +# applicable, {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} -# -# Wordwrap the javadoc comments -# -reformat.comments=true +# Description of the main arguments +main.param.descr=The command line arguments -# -# Single line comment type -# +# 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, +# {3} is the name of the attribute with the first letter lowercased +adder.descr=Adds a feature to the {0} attribute of the {1} {2} -# -# 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 +# Description of the add argument +adder.param.descr=The feature to be added to the {0} attribute +# 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 -# -# Indent the name of the field to this column (-1 for just one space) -# -field.name.indent=-1 +junit.test.descr=A unit test for JUnit +junit.tearDown.descr=The teardown method for JUnit -# -# Include javadoc comments where ever they appear -# -keep.all.javadoc=false +junit.suite.descr=A unit test suite for JUnit +junit.suite.return.descr=The test suite # -# End of line character(s) - either CR, CRNL, or NL -# CR means carriage return, NL means newline +# The following are the tags and the order +# that are required in javadocs. If there is +# description, then they are not required and the +# system is only specifying the order in which they +# should appear. If a description is provided, then +# the tag is required. # -end.line=CRNL +created.descr={1} -# -# Absolute indent before a single line comment. -# -singleline.comment.absoluteindent=0 +param.descr= -# -# Space used before the start of a single line -# from the end of the code -# -singleline.comment.incrementalindent=0 +return.descr= -# -# 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 +exception.descr= -# -# 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 +class.tags=author,created +method.tags=param,return,exception +field.tags= + +# 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) +# * 3 - ASCII full (2 byte characters - far east) +char.stream.type=1 + +# If you would like the pretty printer to make a backup +# of the file before applying the pretty printer to the file, +# add an extension here. +pretty.printer.backup.ext= + +# Insert the header + +# Insert the footer + +# Should we sort the types and imports? +sort.top=false + +# List the prefixes of imports that should be +# sorted to the top. For instance, +# java,javax,org.w3c +import.sort.important=java,javax,org + +# If you want classes that are written by you to move to the end +# of the list of imports change this value. +# * 0 - Keep all the imports in alphabetical order +# * 1 - If the package and the import start with the same value - com or org - put them at the end +# * 2 - When package and import share 2 directory levels, the imports are listed last +# * 3 - When package and import share 3 directory levels, the imports are listed last +import.sort.neighbourhood=1 + +# The following controls the order of methods, fields, +# classes, etc inside a class. +# This orders the items in the class by their type +# The items to order are fields, constructors, methods, +# nested classes, nested interfaces, and initializers +sort.1=Type(Field,Initializer,Constructor,Method,NestedClass,NestedInterface) + +# How static methods and fields should be sorted +# * Class(Static,Instance) - Move static to the top +# * Class(Instance,Static) - Move static to the bottom +sort.2=Class(Static,Instance) +# How the protection should be used to sort fields and methods +# * Protection(public) - Move public to the top +# * Protection(private) - Move private to the top +sort.3=Protection(public) +# Order getters, setters, and other methods +# Setters are methods that start with the word 'set' +# Getters are methods that start with the word 'get' or 'is' +sort.4=Method(getter,setter,other) + +# How final methods and fields should be sorted +# * Final(top) - Move to the top +# * Final(bottom) - Move to the bottom +sort.5=Final(top) +# Order methods and fields in alphabetical order +#sort.6=Alphabetical() + +# Maintain the order of fields with initializers +#sort.7=FieldInitializers()
_______________________________________________ Xdoclet-devel mailing list [EMAIL PROTECTED] https://lists.sourceforge.net/lists/listinfo/xdoclet-devel