mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-04-29 19:45:01 +02:00
Code Issues Wiki Activity

Javadoc adjustments.

Browse source
This commit is contained in:
Sergey Prigogin 2013-03-31 14:46:54 -07:00
parent 52aa9bac76
commit a83be9db5b
1 changed files with 19 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ToolFactory.java
View file

@ -27,14 +27,13 @@ import org.eclipse.core.runtime.Platform;
* @noinstantiate This class is not intended to be instantiated by clients. * @noinstantiate This class is not intended to be instantiated by clients.
*/ */
public class ToolFactory { public class ToolFactory {
/** /**
* Create an instance of a code formatter. A code formatter implementation can be contributed via the * Creates an instance of a code formatter. A code formatter implementation can be contributed
* extension point "org.eclipse.cdt.core.CodeFormatter". If unable to find a registered extension, the factory * via the extension point "org.eclipse.cdt.core.CodeFormatter". If unable to find a registered
* will default to using the default code formatter. * extension, the factory will default to using the default code formatter.
* @param options - the options map to use for formatting with the code formatter. Recognized options * @param options - the options map to use for formatting with the code formatter. Recognized
* are documented on <code>DefaultCodeFormatterConstants</code>. If set to <code>null</code>, then use * options are documented in {@link DefaultCodeFormatterConstants}. If set to {@code null},
* the current settings from <code>CCorePlugin.getOptions()</code>. * then use the current settings from {@code CCorePlugin.getOptions()}.
* @return an instance of either a contributed the built-in code formatter * @return an instance of either a contributed the built-in code formatter
* @see CodeFormatter * @see CodeFormatter
* @see DefaultCodeFormatterConstants * @see DefaultCodeFormatterConstants
@ -72,11 +71,11 @@ public class ToolFactory {
} }
/** /**
* Create an instance of the built-in code formatter. * Creates an instance of the built-in code formatter.
* *
* @param options - the options map to use for formatting with the default code formatter. Recognized options * @param options - the options map to use for formatting with the default code formatter.
* are documented on <code>DefaultCodeFormatterConstants</code>. If set to <code>null</code>, then use * Recognized options are documented in {@link DefaultCodeFormatterConstants}. If set to
* the current settings from <code>CCorePlugin.getOptions()</code>. * {@code null}, then use the current settings from {@code CCorePlugin.getOptions()}.
* @return an instance of the built-in code formatter * @return an instance of the built-in code formatter
* @see CodeFormatter * @see CodeFormatter
* @see DefaultCodeFormatterConstants * @see DefaultCodeFormatterConstants
@ -87,4 +86,6 @@ public class ToolFactory {
options = CCorePlugin.getOptions(); options = CCorePlugin.getOptions();
return new CCodeFormatter(options); return new CCodeFormatter(options);
} }
private ToolFactory() {}
} }