X-Git-Url: http://git.phpeclipse.com diff --git a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/ICodeFormatter.java b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/ICodeFormatter.java index d960dc3..f9c08f9 100644 --- a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/ICodeFormatter.java +++ b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/ICodeFormatter.java @@ -13,9 +13,10 @@ package net.sourceforge.phpdt.core; import java.util.Map; /** - * Specification for a generic source code formatter. Client plug-ins can contribute - * an implementation for an ICodeFormatter, through the extension point "org.phpeclipse.phpdt.core.codeFormatter". - * In case none is found, a default formatter can be provided through the ToolFactory. + * Specification for a generic source code formatter. Client plug-ins can + * contribute an implementation for an ICodeFormatter, through the extension + * point "org.phpeclipse.phpdt.core.codeFormatter". In case none is found, a + * default formatter can be provided through the ToolFactory. * * @see ToolFactory#createCodeFormatter() * @see ToolFactory#createDefaultCodeFormatter(Map options) @@ -23,23 +24,29 @@ import java.util.Map; */ public interface ICodeFormatter { - /** - * Formats the String sourceString, - * and returns a string containing the formatted version. + /** + * Formats the String sourceString, and returns a string + * containing the formatted version. * - * @param string the string to format - * @param indentationLevel the initial indentation level, used - * to shift left/right the entire source fragment. An initial indentation - * level of zero has no effect. - * @param positions an array of positions to map. These are - * character-based source positions inside the original source, - * for which corresponding positions in the formatted source will - * be computed (so as to relocate elements associated with the original - * source). It updates the positions array with updated positions. - * If set to null, then no positions are mapped. - * @param lineSeparator the line separator to use in formatted source, - * if set to null, then the platform default one will be used. + * @param string + * the string to format + * @param indentationLevel + * the initial indentation level, used to shift left/right the + * entire source fragment. An initial indentation level of zero + * has no effect. + * @param positions + * an array of positions to map. These are character-based source + * positions inside the original source, for which corresponding + * positions in the formatted source will be computed (so as to + * relocate elements associated with the original source). It + * updates the positions array with updated positions. If set to + * null, then no positions are mapped. + * @param lineSeparator + * the line separator to use in formatted source, if set to + * null, then the platform default one will be + * used. * @return the formatted output string. */ - String format(String string, int indentationLevel, int[] positions, String lineSeparator); + String format(String string, int indentationLevel, int[] positions, + String lineSeparator); }