From 7a237aaa0ef0d15fcaf7041604e4a033acf1836a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torbj=C3=B6rn=20Svensson?= Date: Sun, 5 Dec 2021 12:15:27 +0100 Subject: [PATCH] Fix usage or reserved symbols (<>&) in javadoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Contributed by STMicroelectronics Change-Id: Ifdf90e316d7537848bea8253973864f070b19b1c Signed-off-by: Torbjörn Svensson --- .../eclipse/cdt/utils/WindowsRegistry.java | 8 +++--- .../src/org/eclipse/cdt/utils/pty/ConPTY.java | 2 +- .../src/org/eclipse/cdt/utils/pty/PTY.java | 2 +- .../providers/LanguageSettingsManager.java | 2 +- .../LanguageSettingsSerializableProvider.java | 2 +- .../org/eclipse/cdt/core/model/CoreModel.java | 4 +-- .../model/ICConfigurationDescription.java | 4 +-- .../model/ICProjectDescriptionManager.java | 2 +- .../core/settings/model/ICSettingEntry.java | 2 +- .../extension/CConfigurationDataProvider.java | 2 +- .../core/dom/ast/IASTAlignmentSpecifier.java | 12 ++++----- .../core/dom/ast/IASTBinaryExpression.java | 26 +++++++++---------- .../dom/ast/IASTElaboratedTypeSpecifier.java | 2 +- .../cdt/core/dom/ast/IASTFieldReference.java | 4 +-- .../eclipse/cdt/core/dom/ast/IASTNode.java | 2 +- .../ast/IASTStandardFunctionDeclarator.java | 2 +- .../cdt/core/dom/ast/IASTUnaryExpression.java | 4 +-- .../dom/ast/cpp/ICPPASTAliasDeclaration.java | 2 +- .../dom/ast/cpp/ICPPASTCastExpression.java | 8 +++--- .../ast/cpp/ICPPASTFunctionDeclarator.java | 4 +-- .../dom/ast/cpp/ICPPASTReferenceOperator.java | 4 +-- .../ICPPASTStructuredBindingDeclaration.java | 14 +++++----- ...ICPPASTTemplatedTypeTemplateParameter.java | 2 +- ...CPPClassTemplatePartialSpecialization.java | 4 +-- .../core/dom/ast/cpp/ICPPReferenceType.java | 2 +- .../dom/ast/gnu/IGNUASTGotoStatement.java | 2 +- .../ast/gnu/c/ICASTKnRFunctionDeclarator.java | 6 ++--- .../ast/gnu/cpp/IGPPASTBinaryExpression.java | 4 +-- ...AbstractScannerExtensionConfiguration.java | 2 +- .../c/ICParserExtensionConfiguration.java | 6 ++--- .../cpp/ICPPParserExtensionConfiguration.java | 6 ++--- .../dom/rewrite/MacroExpansionExplorer.java | 2 +- .../export/AbstractExportProjectProvider.java | 2 +- .../org/eclipse/cdt/core/parser/IProblem.java | 2 +- .../org/eclipse/cdt/core/parser/IScanner.java | 2 +- .../cdt/core/parser/util/ArrayUtil.java | 2 +- .../cdt/core/parser/util/CollectionUtils.java | 2 +- .../src/org/eclipse/cdt/core/CCorePlugin.java | 6 ++--- .../eclipse/cdt/core/ICDescriptorManager.java | 2 +- .../cdt/core/ICExtensionReference.java | 4 +-- .../org/eclipse/cdt/core/ISourceFinder.java | 4 +-- .../cdtvariables/ICdtVariableManager.java | 4 +-- .../cdt/core/envvar/IEnvironmentVariable.java | 4 +-- .../DefaultCodeFormatterConstants.java | 4 +-- .../DefaultCodeFormatterOptions.java | 2 +- .../core/formatter/IndentManipulation.java | 2 +- .../resources/IPathEntryVariableManager.java | 14 +++++----- .../processes/CreateResourceIdentifier.java | 2 +- .../processes/SetEnvironmentVariable.java | 18 ++++++------- .../eclipse/cdt/utils/CommandLineUtil.java | 20 +++++++------- .../cdtvariables/CdtVariableResolver.java | 2 +- 51 files changed, 124 insertions(+), 124 deletions(-) diff --git a/core/org.eclipse.cdt.core.native/src/org/eclipse/cdt/utils/WindowsRegistry.java b/core/org.eclipse.cdt.core.native/src/org/eclipse/cdt/utils/WindowsRegistry.java index 9dca255178a..27dbe96fa4c 100644 --- a/core/org.eclipse.cdt.core.native/src/org/eclipse/cdt/utils/WindowsRegistry.java +++ b/core/org.eclipse.cdt.core.native/src/org/eclipse/cdt/utils/WindowsRegistry.java @@ -60,10 +60,10 @@ public abstract class WindowsRegistry { public abstract String getLocalMachineValue(String subkey, String name); /** - * Given a subkey of HKEY_LOCAL_MACHINE, return the map of valueName => value. + * Given a subkey of HKEY_LOCAL_MACHINE, return the map of valueName =gt; value. * The return value is an empty map on error or when the subkey does not exist. * @param subkey subkey of HKEY_LOCAL_MACHINE - * @return valueName => value map of the entries in subkey + * @return valueName => value map of the entries in subkey * @since 6.1 */ public abstract Map getLocalMachineValues(String subkey); @@ -103,10 +103,10 @@ public abstract class WindowsRegistry { public abstract String getCurrentUserValue(String subkey, String name); /** - * Given a subkey of HKEY_CURRENT_USER, return the map of valueName => value. + * Given a subkey of HKEY_CURRENT_USER, return the map of valueName => value. * The return value is an empty map on error or when the subkey does not exist. * @param subkey subkey of HKEY_CURRENT_USER - * @return valueName => value map of the entries in subkey + * @return valueName => value map of the entries in subkey * @since 6.1 */ public abstract Map getCurrentUserValues(String subkey); diff --git a/core/org.eclipse.cdt.core.native/src/org/eclipse/cdt/utils/pty/ConPTY.java b/core/org.eclipse.cdt.core.native/src/org/eclipse/cdt/utils/pty/ConPTY.java index ec577821083..22f2e4c738d 100644 --- a/core/org.eclipse.cdt.core.native/src/org/eclipse/cdt/utils/pty/ConPTY.java +++ b/core/org.eclipse.cdt.core.native/src/org/eclipse/cdt/utils/pty/ConPTY.java @@ -194,7 +194,7 @@ public class ConPTY { } /** - * Implements the contract of {@link Process#waitFor()}. This is used by {@link PTY#waitFor(org.eclipse.cdt.utils.spawner.Spawner, int), + * Implements the contract of {@link Process#waitFor()}. This is used by {@link PTY#waitFor(org.eclipse.cdt.utils.spawner.Spawner, int)}, * but in the Spawner case the PID is passed around unnecessarily. This method therefore waits for the process it created only, * like how Process#waitFor() behaves. * diff --git a/core/org.eclipse.cdt.core.native/src/org/eclipse/cdt/utils/pty/PTY.java b/core/org.eclipse.cdt.core.native/src/org/eclipse/cdt/utils/pty/PTY.java index 235b3f6f547..4b0537edbb4 100644 --- a/core/org.eclipse.cdt.core.native/src/org/eclipse/cdt/utils/pty/PTY.java +++ b/core/org.eclipse.cdt.core.native/src/org/eclipse/cdt/utils/pty/PTY.java @@ -104,7 +104,7 @@ public class PTY { /** * Create PTY for use with Eclipse console. - * Identical to {@link PTY#PTY(Mode.CONSOLE)}. + * Identical to PTY(Mode.CONSOLE). */ public PTY() throws IOException { this(Mode.CONSOLE); diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsManager.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsManager.java index 2fc760c77ad..2d75d6c975d 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsManager.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsManager.java @@ -48,7 +48,7 @@ public class LanguageSettingsManager { * for the given configuration description, resource and language. This is a * combined list for all providers taking into account settings of parent folder * if settings for the given resource are not defined. For include paths both - * local (#include "...") and system (#include <...>) entries are returned. + * local (#include "...") and system (#include <...>) entries are returned. * * @param cfgDescription - configuration description. * @param rc - resource such as file or folder. diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsSerializableProvider.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsSerializableProvider.java index a11e4a7903e..bcd849b1074 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsSerializableProvider.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsSerializableProvider.java @@ -165,7 +165,7 @@ public class LanguageSettingsSerializableProvider extends LanguageSettingsBasePr * {@link #setSettingEntries(ICConfigurationDescription, IResource, String, List)}. *

* Note also that you can compare these lists with simple equality operator ==, - * as the lists themselves are backed by WeakHashSet> where + * as the lists themselves are backed by WeakHashSet<List<ICLanguageSettingEntry>> where * identical copies (deep comparison is used) are replaced with the same one instance. */ @Override diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/model/CoreModel.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/model/CoreModel.java index 90630584253..34fc11b7b75 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/model/CoreModel.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/model/CoreModel.java @@ -1424,10 +1424,10 @@ public class CoreModel { * * Each getProjectDescription(project, true) returns a new copy of the project description * - * The writable description uses the cached data untill the first set call + * The writable description uses the cached data until the first set call * after that the description communicates directly to the Build System * i.e. the implementer of the org.eclipse.cdt.core.CConfigurationDataProvider extension - * This ensures the Core<->Build System settings integrity + * This ensures the Core<->Build System settings integrity * * @return {@link ICProjectDescription} or null if the project does not contain the * CDT data associated with it. diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICConfigurationDescription.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICConfigurationDescription.java index 9bdc0a3ff55..ffb3a87215f 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICConfigurationDescription.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICConfigurationDescription.java @@ -234,7 +234,7 @@ public interface ICConfigurationDescription extends ICSettingContainer, ICSettin * If the current configuration does not reference any other configurations, * an empty map is returned. * - * @return Map of referenced Project -> Configuration ID + * @return Map<String,String> of referenced Project -> Configuration ID * @see #setReferenceInfo(Map) * @see #getExternalSettings() * @see #createExternalSetting(String[], String[], String[], ICSettingEntry[]) @@ -250,7 +250,7 @@ public interface ICConfigurationDescription extends ICSettingContainer, ICSettin * The empty string is a special configuration value which indicates the reference * tracks the Active configuration in the referenced Project. * - * @param refs Map of project name -> configuration ID of referenced configurations + * @param refs Map of project name -> configuration ID of referenced configurations * @throws WriteAccessException when the configuration description is read-only * see {@link CoreModel#getProjectDescription(org.eclipse.core.resources.IProject, boolean)} * @see {@link #getReferenceInfo()}
diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICProjectDescriptionManager.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICProjectDescriptionManager.java index 17c382f5f70..a7ca68e58bc 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICProjectDescriptionManager.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICProjectDescriptionManager.java @@ -176,7 +176,7 @@ public interface ICProjectDescriptionManager { * The writable description uses the cached data until the first set call * after that the description communicates directly to the Build System * i.e. the implementer of the org.eclipse.cdt.core.CConfigurationDataProvider extension - * This ensures the Core<->Build System settings integrity + * This ensures the Core<->Build System settings integrity * * @return {@link ICProjectDescription} or null if the project does not contain the * CDT data associated with it. diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICSettingEntry.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICSettingEntry.java index db7eda528ea..8836a863fd8 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICSettingEntry.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICSettingEntry.java @@ -47,7 +47,7 @@ public interface ICSettingEntry { /** * Flag {@code LOCAL} is used during creation of {@link IIncludeEntry} * to indicate that an include path is not a system path. - * "System" path is denoted by angle brackets as in #include + * "System" path is denoted by angle brackets as in #include <x.h> * "Local" path is denoted by quotes as in #include "x.h" */ int LOCAL = 1 << 2; diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/extension/CConfigurationDataProvider.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/extension/CConfigurationDataProvider.java index cee85a47d8f..eb57aaeacec 100644 --- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/extension/CConfigurationDataProvider.java +++ b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/extension/CConfigurationDataProvider.java @@ -37,7 +37,7 @@ public abstract class CConfigurationDataProvider { * The method can be called in following cases: *
* 1. Loading configuration from external data source such as .cproject.
- * 2. Loading preference configuration defined in Preferences -> C/C++ -> New project Wizard -> Makefile Project. + * 2. Loading preference configuration defined in Preferences -> C/C++ -> New project Wizard -> Makefile Project. * * @param cfgDescription - configuration description being loaded. * @param monitor - progress monitor. diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTAlignmentSpecifier.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTAlignmentSpecifier.java index 9d555ad597c..8e17c414e6f 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTAlignmentSpecifier.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTAlignmentSpecifier.java @@ -20,11 +20,11 @@ package org.eclipse.cdt.core.dom.ast; * * Possible forms are: * C++: - * alignas() - * alignas() + * alignas(<type-id>) + * alignas(<expression>) * C: - * _Alignas() - * _Alignas() + * _Alignas(<type-id>) + * _Alignas(<expression>) * @noimplement This interface is not intended to be implemented by clients. * @noextend This interface is not intended to be extended by clients. * @since 5.10 @@ -39,13 +39,13 @@ public interface IASTAlignmentSpecifier extends IASTNode { "IASTAlignmentSpecifier.ALIGNMENT_TYPEID - Type-id in alignment specifier"); //$NON-NLS-1$ /** - * If the specifier is of the form 'alignas()' or '_Alignas()', + * If the specifier is of the form 'alignas(<expression>)' or '_Alignas(<expression>)', * returns the enclosed expression. Otherwise, returns null. */ IASTExpression getExpression(); /** - * If the specifier is of the form 'alignas()' or '_Alignas()', + * If the specifier is of the form 'alignas(<type-id>)' or '_Alignas(<type-id>)', * returns the enclosed type-id. Otherwise, returns null. */ IASTTypeId getTypeId(); diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTBinaryExpression.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTBinaryExpression.java index a010247656e..af70cd64de0 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTBinaryExpression.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTBinaryExpression.java @@ -77,37 +77,37 @@ public interface IASTBinaryExpression extends IASTExpression { public static final int op_minus = 5; /** - * shift left << + * shift left << */ public static final int op_shiftLeft = 6; /** - * shift right >> + * shift right >> */ public static final int op_shiftRight = 7; /** - * less than < + * less than < */ public static final int op_lessThan = 8; /** - * greater than > + * greater than > */ public static final int op_greaterThan = 9; /** - * less than or equals <= + * less than or equals <= */ public static final int op_lessEqual = 10; /** - * greater than or equals >= + * greater than or equals >= */ public static final int op_greaterEqual = 11; /** - * binary and & + * binary and & */ public static final int op_binaryAnd = 12; @@ -122,7 +122,7 @@ public interface IASTBinaryExpression extends IASTExpression { public static final int op_binaryOr = 14; /** - * logical and && + * logical and && */ public static final int op_logicalAnd = 15; @@ -162,17 +162,17 @@ public interface IASTBinaryExpression extends IASTExpression { public static final int op_minusAssign = 22; /** - * shift left assignment <<= + * shift left assignment <<= */ public static final int op_shiftLeftAssign = 23; /** - * shift right assign >>= + * shift right assign >>= */ public static final int op_shiftRightAssign = 24; /** - * binary and assign &= + * binary and assign &= */ public static final int op_binaryAndAssign = 25; @@ -210,13 +210,13 @@ public interface IASTBinaryExpression extends IASTExpression { /** * For g++, only. - * op_max represents >? + * op_max represents >? */ public static final int op_max = 32; /** * For g++, only. - * op_min represents op_min represents <? */ public static final int op_min = 33; diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTElaboratedTypeSpecifier.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTElaboratedTypeSpecifier.java index fa5adac9fb0..48b567b058a 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTElaboratedTypeSpecifier.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTElaboratedTypeSpecifier.java @@ -14,7 +14,7 @@ package org.eclipse.cdt.core.dom.ast; /** - * This represents an elaborated type specifier in the C & C++ language grammar. + * This represents an elaborated type specifier in the C & C++ language grammar. * * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTFieldReference.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTFieldReference.java index f2964382946..9aed1bff89f 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTFieldReference.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTFieldReference.java @@ -14,8 +14,8 @@ package org.eclipse.cdt.core.dom.ast; /** - * This interface represents expressions that access a field reference. e.g. a.b => a - * is the expression, b is the field name. e.g. a()->def => a() is the + * This interface represents expressions that access a field reference. e.g. a.b => a + * is the expression, b is the field name. e.g. a()->def => a() is the * expression, def is the field name. * * @noextend This interface is not intended to be extended by clients. diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTNode.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTNode.java index 685f176845d..b19df0a2ab1 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTNode.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTNode.java @@ -63,7 +63,7 @@ public interface IASTNode { *

* Nodes that span file context into a macro expansion (and potentially out * of the macro expansion again) result in an IASTNodeLocation[] result - * that is of length > 1. + * that is of length > 1. *

* We do not provide meaningful node locations for nested macro references * (see {@link IASTPreprocessorMacroExpansion#getNestedMacroReferences()}). diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTStandardFunctionDeclarator.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTStandardFunctionDeclarator.java index 5b16a8ad407..7b866cada12 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTStandardFunctionDeclarator.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTStandardFunctionDeclarator.java @@ -15,7 +15,7 @@ package org.eclipse.cdt.core.dom.ast; /** - * This is a declarator for a non K&R C function. + * This is a declarator for a non K&R C function. * * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTUnaryExpression.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTUnaryExpression.java index 9c78146e9f7..683be73d85d 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTUnaryExpression.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTUnaryExpression.java @@ -53,7 +53,7 @@ public interface IASTUnaryExpression extends IASTExpression { /** * Operator ampersand. - * {@code op_amper}: &exp + * {@code op_amper}: &exp */ public static final int op_amper = 5; @@ -129,7 +129,7 @@ public interface IASTUnaryExpression extends IASTExpression { public static final int op_noexcept = 17; /** - * For GCC parsers, only. {@code op_labelReference} is used for &&label type expressions. + * For GCC parsers, only. {@code op_labelReference} is used for &&label type expressions. * @since 5.8 */ public static final int op_labelReference = 18; diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTAliasDeclaration.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTAliasDeclaration.java index 723dcff8829..130f657c172 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTAliasDeclaration.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTAliasDeclaration.java @@ -38,7 +38,7 @@ public interface ICPPASTAliasDeclaration extends IASTDeclaration, IASTNameOwner, "ICPPASTAliasDeclaration.ALIAS_NAME - Introduced alias name"); //$NON-NLS-1$ /** - * MAPPING_TYPE represents the pre-existing type id which + * MAPPING_TYPEID represents the pre-existing type id which * the new symbol aliases. */ public static final ASTNodeProperty TARGET_TYPEID = new ASTNodeProperty( diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTCastExpression.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTCastExpression.java index 7f276883075..e095152ccf7 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTCastExpression.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTCastExpression.java @@ -23,22 +23,22 @@ import org.eclipse.cdt.core.dom.ast.IASTCastExpression; */ public interface ICPPASTCastExpression extends IASTCastExpression, ICPPASTExpression { /** - * op_dynamic_cast is used for dynamic_cast<>'s. + * op_dynamic_cast is used for dynamic_cast<>'s. */ public static final int op_dynamic_cast = IASTCastExpression.op_last + 1; /** - * op_static_cast is used for static_cast<>'s. + * op_static_cast is used for static_cast<>'s. */ public static final int op_static_cast = IASTCastExpression.op_last + 2; /** - * op_reinterpret_cast is used for reinterpret_cast<>'s. + * op_reinterpret_cast is used for reinterpret_cast<>'s. */ public static final int op_reinterpret_cast = IASTCastExpression.op_last + 3; /** - * op_const_cast is used for const_cast<>'s. + * op_const_cast is used for const_cast<>'s. */ public static final int op_const_cast = IASTCastExpression.op_last + 4; diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTFunctionDeclarator.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTFunctionDeclarator.java index 0180b30de3c..ca4304ce84c 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTFunctionDeclarator.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTFunctionDeclarator.java @@ -182,13 +182,13 @@ public interface ICPPASTFunctionDeclarator extends IASTStandardFunctionDeclarato public void setNoexceptExpression(ICPPASTExpression expression); /** - * Returns the trailing return type as in auto f() -> int , or null. + * Returns the trailing return type as in auto f() -gt; int , or null. * @since 5.2 */ public IASTTypeId getTrailingReturnType(); /** - * Trailing return type as in auto f() -> int . + * Trailing return type as in auto f() -> int . * @since 5.2 */ public void setTrailingReturnType(IASTTypeId typeId); diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTReferenceOperator.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTReferenceOperator.java index fb667e08eb3..4943f4684ae 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTReferenceOperator.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTReferenceOperator.java @@ -17,14 +17,14 @@ package org.eclipse.cdt.core.dom.ast.cpp; import org.eclipse.cdt.core.dom.ast.IASTPointerOperator; /** - * This is C++'s reference operator, i.e. &, used in a declarator. + * This is C++'s reference operator, i.e. &, used in a declarator. * * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. */ public interface ICPPASTReferenceOperator extends IASTPointerOperator { /** - * Returns whether the operator denotes a rvalue reference (e.g. int &&). + * Returns whether the operator denotes a rvalue reference (e.g. int &&). * @since 5.2 */ public boolean isRValueReference(); diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTStructuredBindingDeclaration.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTStructuredBindingDeclaration.java index 8eff34af474..ff6b95412ff 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTStructuredBindingDeclaration.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTStructuredBindingDeclaration.java @@ -32,8 +32,8 @@ import org.eclipse.jdt.annotation.Nullable; * Examples: *

    *
  • auto [x, y]{coordinate};
    • - *
  • auto & [x, y](coordinate);
    • - *
  • auto && [x, y] = createCoordinte();
    • + *
  • auto & [x, y](coordinate);
    • + *
  • auto && [x, y] = createCoordinte();
    • *
* * @since 6.9 @@ -64,8 +64,8 @@ public interface ICPPASTStructuredBindingDeclaration * Examples: *
    *
  • For auto [x, y] = coordinate; it returns the empty Optional
    • - *
  • For auto & [x, y] = coordinate; it returns Optional.of(RefQualifier.LVALUE)
    • - *
  • For auto && [x, y] = createCoordinte(); it returns Optional.of(RefQualifier.RVALUE)
    • + *
  • For auto & [x, y] = coordinate; it returns Optional.of(RefQualifier.LVALUE)
    • + *
  • For auto && [x, y] = createCoordinte(); it returns Optional.of(RefQualifier.RVALUE)
    • *
* * @return The returned RefQualifier of the C++ declaration or null if there is no reference qualifier. @@ -78,7 +78,7 @@ public interface ICPPASTStructuredBindingDeclaration /** * Returns the list of names declared by this structured binding declaration. *

- * Example: For auto & [x, y] = coordinate; it returns the names x and y. + * Example: For auto & [x, y] = coordinate; it returns the names x and y. * * @return All declared names of the structured binding asIASTName[] * @see IASTName @@ -93,8 +93,8 @@ public interface ICPPASTStructuredBindingDeclaration * * Examples: *

    *
  • For auto [x, y]{coordinate}; it returns an ICPPASTInitializerList
    • - *
  • For auto & [x, y](coordinate); it returns an ICPPASTConstructorInitializer
    • - *
  • For auto && [x, y] = createCoordinte(); it returns an IASTEqualsInitializer
    • + *
  • For auto & [x, y](coordinate); it returns an ICPPASTConstructorInitializer
    • + *
  • For auto && [x, y] = createCoordinte(); it returns an IASTEqualsInitializer
    • *
* * @return The IASTInitializer of this structured binding. It can be null if the C++ declaration is lacking an initializer. diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTTemplatedTypeTemplateParameter.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTTemplatedTypeTemplateParameter.java index 6d0d382ec0a..815f040651f 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTTemplatedTypeTemplateParameter.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTTemplatedTypeTemplateParameter.java @@ -21,7 +21,7 @@ import org.eclipse.cdt.core.dom.ast.IASTNameOwner; /** * This is a template template parameter as V in - * template<template<typename T> class V> class CT; + * template<template<typename T> class V> class CT; * * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPClassTemplatePartialSpecialization.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPClassTemplatePartialSpecialization.java index e2413572319..d543fbe93b2 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPClassTemplatePartialSpecialization.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPClassTemplatePartialSpecialization.java @@ -19,8 +19,8 @@ package org.eclipse.cdt.core.dom.ast.cpp; * a class template in its own right. * * E.g.: - * template class A {}; // the primary class template - * template class A {}; // a partial specialization of the primary class template + * template <class T> class A {}; // the primary class template + * template <class T> class A<T*> {}; // a partial specialization of the primary class template * * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPReferenceType.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPReferenceType.java index 76f2c6148cf..b9be8aa5211 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPReferenceType.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPReferenceType.java @@ -27,7 +27,7 @@ public interface ICPPReferenceType extends IType { public IType getType(); /** - * Returns whether this is an rvalue reference (e.g: int&&) + * Returns whether this is an rvalue reference (e.g: int&&) * @since 5.2 */ public boolean isRValueReference(); diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/gnu/IGNUASTGotoStatement.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/gnu/IGNUASTGotoStatement.java index 8ffd30eafcd..84f45b48ed4 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/gnu/IGNUASTGotoStatement.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/gnu/IGNUASTGotoStatement.java @@ -23,7 +23,7 @@ import org.eclipse.cdt.core.dom.ast.IASTStatement; * * * foo: - * void *labelPtr = &&foo; + * void *labelPtr = &&foo; * goto *labelPtr; * * diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/gnu/c/ICASTKnRFunctionDeclarator.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/gnu/c/ICASTKnRFunctionDeclarator.java index 2d1f46dca31..b198908968b 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/gnu/c/ICASTKnRFunctionDeclarator.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/gnu/c/ICASTKnRFunctionDeclarator.java @@ -20,14 +20,14 @@ import org.eclipse.cdt.core.dom.ast.IASTFunctionDeclarator; import org.eclipse.cdt.core.dom.ast.IASTName; /** - * This is the declarator for a K&R C Function. + * This is the declarator for a K&R C Function. * * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. */ public interface ICASTKnRFunctionDeclarator extends IASTFunctionDeclarator { /** - * PARAMETER_NAME refers to the names qualified in a K&R C + * PARAMETER_NAME refers to the names qualified in a K&R C * function definition. */ public static final ASTNodeProperty PARAMETER_NAME = new ASTNodeProperty( @@ -35,7 +35,7 @@ public interface ICASTKnRFunctionDeclarator extends IASTFunctionDeclarator { /** * FUNCTION_PARAMETER represents the relationship between an - * K&R function declarator and the full parameter declarations. + * K&R function declarator and the full parameter declarations. */ public static final ASTNodeProperty FUNCTION_PARAMETER = new ASTNodeProperty( "ICASTKnRFunctionDeclarator.FUNCTION_PARAMETER - Full K&R Parameter Declaration"); //$NON-NLS-1$ diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/gnu/cpp/IGPPASTBinaryExpression.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/gnu/cpp/IGPPASTBinaryExpression.java index cc33507d0e4..6f08087359f 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/gnu/cpp/IGPPASTBinaryExpression.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/gnu/cpp/IGPPASTBinaryExpression.java @@ -24,12 +24,12 @@ import org.eclipse.cdt.core.dom.ast.cpp.ICPPASTBinaryExpression; */ public interface IGPPASTBinaryExpression extends ICPPASTBinaryExpression { /** - * op_max represents >? + * op_max represents >? */ public static final int op_max = IASTBinaryExpression.op_max; /** - * op_min represents op_min represents <? */ public static final int op_min = IASTBinaryExpression.op_min; diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/AbstractScannerExtensionConfiguration.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/AbstractScannerExtensionConfiguration.java index 810288e77af..61d4860740f 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/AbstractScannerExtensionConfiguration.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/AbstractScannerExtensionConfiguration.java @@ -155,7 +155,7 @@ public abstract class AbstractScannerExtensionConfiguration implements IScannerE * The macro can either be of object- or of function-style. * 
 	 * Example:
-	 *    addMacro("max(a,b)", "(((a)>(b) ? (a) : (b))");
+	 *    addMacro("max(a,b)", "(((a)>(b) ? (a) : (b))");
 	 *
* @param signature the signature of the macro, see {@link IMacro#getSignature()}. * @param value the macro value diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/c/ICParserExtensionConfiguration.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/c/ICParserExtensionConfiguration.java index 132722b448e..0a66ebee486 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/c/ICParserExtensionConfiguration.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/c/ICParserExtensionConfiguration.java @@ -67,9 +67,9 @@ public interface ICParserExtensionConfiguration { public boolean supportAlignOfUnaryExpression(); /** - * Support for Kernighan and Richie (K&R) C. + * Support for Kernighan and Richie (K&R) C. * - * @return true if support for K&R C should be enabled + * @return true if support for K&R C should be enabled */ public boolean supportKnRC(); @@ -101,7 +101,7 @@ public interface ICParserExtensionConfiguration { /** * Skips information in brackets provided at the beginning of a parameter declaration: *
- * void accelerate([proc=marsh] const Speed &data); + * void accelerate([proc=marsh] const Speed &data); * @since 5.1 */ public boolean supportParameterInfoBlock(); diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/cpp/ICPPParserExtensionConfiguration.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/cpp/ICPPParserExtensionConfiguration.java index 4694648664d..6865ec253c4 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/cpp/ICPPParserExtensionConfiguration.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/cpp/ICPPParserExtensionConfiguration.java @@ -92,9 +92,9 @@ public interface ICPPParserExtensionConfiguration { public boolean supportAlignOfUnaryExpression(); /** - * Support for Kernighan and Richie (K&R) C. + * Support for Kernighan and Richie (K&R) C. * - * @return {@code true} if support for K&R C should be enabled + * @return {@code true} if support for K&R C should be enabled */ public boolean supportKnRC(); @@ -123,7 +123,7 @@ public interface ICPPParserExtensionConfiguration { /** * Skips information in brackets provided at the beginning of a parameter declaration: *
- * void accelerate([proc=marsh] const Speed &data); + * void accelerate([proc=marsh] const Speed &data); * @since 5.1 */ public boolean supportParameterInfoBlock(); diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/rewrite/MacroExpansionExplorer.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/rewrite/MacroExpansionExplorer.java index eb404c83eca..0b97e11e9f9 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/rewrite/MacroExpansionExplorer.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/rewrite/MacroExpansionExplorer.java @@ -88,7 +88,7 @@ public abstract class MacroExpansionExplorer { /** * Returns a description for the requested step within the expansion of the region of this * expansion explorer. - * @throws IndexOutOfBoundsException if step < 0 or step >= getExpansionStepCount(). + * @throws IndexOutOfBoundsException if step < 0 or step >= getExpansionStepCount(). */ public abstract IMacroExpansionStep getExpansionStep(int step) throws IndexOutOfBoundsException; } diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/export/AbstractExportProjectProvider.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/export/AbstractExportProjectProvider.java index 42c97a279b6..ce70474f8d0 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/export/AbstractExportProjectProvider.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/export/AbstractExportProjectProvider.java @@ -61,7 +61,7 @@ public abstract class AbstractExportProjectProvider implements IExportProjectPro * Returns a mapping from string option to parameter string list *
* For example, if -option p1 p2 p3 appears on the command line, then - * the mapping option=>[p1,p2,p3] will be present in the map + * the mapping option=>[p1,p2,p3] will be present in the map * @return a mapping from string option to parameter string list */ protected Map> getParsedArgs() { diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/parser/IProblem.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/parser/IProblem.java index 4eecbf5c53b..4ee891997fc 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/parser/IProblem.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/parser/IProblem.java @@ -123,7 +123,7 @@ public interface IProblem { * types of problems. * * @param bitmask - * @return true if ( (id & bit-mask ) != 0 ) + * @return true if ( (id & bit-mask ) != 0 ) */ public boolean checkCategory(int bitmask); diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/parser/IScanner.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/parser/IScanner.java index 684e98ac6c1..025933621d1 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/parser/IScanner.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/parser/IScanner.java @@ -124,7 +124,7 @@ public interface IScanner { /** * Returns a list of additional (compiler specific) suffixes which can - * be placed on numbers. e.g. 'u' 'l' -> 1l or 1u. + * be placed on numbers. e.g. 'u' 'l' -> 1l or 1u. * * @noreference This method is not intended to be referenced by clients. */ diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/parser/util/ArrayUtil.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/parser/util/ArrayUtil.java index f1262a972f3..7d561deb2f6 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/parser/util/ArrayUtil.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/parser/util/ArrayUtil.java @@ -352,7 +352,7 @@ public abstract class ArrayUtil { /** * Adds all elements of an array to a collection. For an {@link ArrayList} this method is - * slightly more efficient than {@link java.util.Collections#addAll(Collection, T...)}. + * slightly more efficient than {@link java.util.Collections#addAll(Collection, Object...)}. * @since 5.4 */ @SafeVarargs diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/parser/util/CollectionUtils.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/parser/util/CollectionUtils.java index 850435cb8ad..634a650a096 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/parser/util/CollectionUtils.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/parser/util/CollectionUtils.java @@ -145,7 +145,7 @@ public final class CollectionUtils { } /** - * Returns a List corresponding to a T in a Map>. If the mapping doesn't exist, + * Returns a List<U> corresponding to a T in a Map<T, List<U>>. If the mapping doesn't exist, * creates it with an empty list as the initial value. * @since 5.6 */ diff --git a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/CCorePlugin.java b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/CCorePlugin.java index acecfbc1e78..cdf0d2f204f 100644 --- a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/CCorePlugin.java +++ b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/CCorePlugin.java @@ -1009,8 +1009,8 @@ public class CCorePlugin extends Plugin { /** * Method convertProjectFromCtoCC converts a C Project to a C++ Project The - * newProject MUST, not be null, already have a C Nature && must NOT already - * have a C++ Nature + * newProject MUST, not be null, already have a C Nature && must + * NOT already have a C++ Nature * * @param projectHandle * @param monitor @@ -1455,7 +1455,7 @@ public class CCorePlugin extends Plugin { * set call after that the description communicates directly to * the Build System i.e. the implementer of the * org.eclipse.cdt.core.CConfigurationDataProvider extension This - * ensures the Core<->Build System settings integrity. + * ensures the Core<->Build System settings integrity. * * @return {@link ICProjectDescription} or null if the project does not * contain the CDT data associated with it. diff --git a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ICDescriptorManager.java b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ICDescriptorManager.java index 6f5a9a52f6b..2922dbf2338 100644 --- a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ICDescriptorManager.java +++ b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ICDescriptorManager.java @@ -21,7 +21,7 @@ import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.IProgressMonitor; /** - * @deprecated replace with {@link ICProjectDescriptionManager} & {@link ICProjectDescription} + * @deprecated replace with {@link ICProjectDescriptionManager} & {@link ICProjectDescription} * @noreference This interface is not intended to be referenced by clients. */ @Deprecated diff --git a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ICExtensionReference.java b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ICExtensionReference.java index 9e46f73feea..15f9b5c2cff 100644 --- a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ICExtensionReference.java +++ b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ICExtensionReference.java @@ -98,8 +98,8 @@ public interface ICExtensionReference { * * 
 	 *  <view>
-	 *      <verticalHint>top</verticalHint>
-	 *      <horizontalHint>left</horizontalHint>
+	 *      <verticalHint>top</verticalHint>
+	 *      <horizontalHint>left</horizontalHint>
 	 *  </view>
 	 *
* diff --git a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ISourceFinder.java b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ISourceFinder.java index b2f6a296e98..41659fa11ac 100644 --- a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ISourceFinder.java +++ b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ISourceFinder.java @@ -30,8 +30,8 @@ import org.eclipse.core.runtime.IAdaptable; *

* CDT has: *

    - *
  • A global (common) source locator. Its containers are defined via Window > Preferences > C/C++ > Debug > - * Source Lookup Path + *
  • A global (common) source locator. Its containers are defined via Window > Preferences > + * C/C++ > Debug > Source Lookup Path *
  • Launch configuration source locators. The containers of such a locator are defined via the 'Source' tab * in a CDT launch configuration. The common source containers are automatically added to this locator. *
  • Launch source locators. Typically, a launch's locator is the one defined in the launch configuration diff --git a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/cdtvariables/ICdtVariableManager.java b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/cdtvariables/ICdtVariableManager.java index dac29b6c897..734bd2d3726 100644 --- a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/cdtvariables/ICdtVariableManager.java +++ b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/cdtvariables/ICdtVariableManager.java @@ -58,7 +58,7 @@ public interface ICdtVariableManager { /** * * converts StringList value into String of the following format: - * "< listDelimiter >< listDelimiter > ... " + * "<value_1>< listDelimiter ><value_2>< listDelimiter > ... <value_n>" */ public String convertStringListToString(String value[], String listDelimiter); @@ -70,7 +70,7 @@ public interface ICdtVariableManager { * expanded to. If null the BuildMacroException is thrown in case the string to be resolved * references inexistent macros * @param listDelimiter if not null, StringList macros are expanded as - * "< listDelimiter >< listDelimiter > ... " + * "<value_1>< listDelimiter ><value_2>< listDelimiter > ... <value_n>" * otherwise the BuildMacroException is thrown in case the string to be resolved references * string-list macros */ diff --git a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/envvar/IEnvironmentVariable.java b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/envvar/IEnvironmentVariable.java index 68ff1545f50..99447f9d12f 100644 --- a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/envvar/IEnvironmentVariable.java +++ b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/envvar/IEnvironmentVariable.java @@ -50,9 +50,9 @@ public interface IEnvironmentVariable { * If the variable already exists and contains some value the new * value will be calculated in the following way: * For the "prepend" operation: - * = + * <New value> = <the value from the getValue() method><delimiter><Old value> * For the "append" operation: - * = + * <New value> = <Old value><delimiter><the value from the getValue() method> * * The Environment Variable Provider will also remove the duplicates of "sub-values" * in the resulting value. diff --git a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/formatter/DefaultCodeFormatterConstants.java b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/formatter/DefaultCodeFormatterConstants.java index 0c2e2d6e25e..e7bed19c143 100644 --- a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/formatter/DefaultCodeFormatterConstants.java +++ b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/formatter/DefaultCodeFormatterConstants.java @@ -2867,9 +2867,9 @@ public class DefaultCodeFormatterConstants { } /** - * Returns the K&R formatter settings + * Returns the K&R formatter settings * - * @return the K&R settings + * @return the K&R settings */ public static Map getKandRSettings() { return DefaultCodeFormatterOptions.getKandRSettings().getMap(); diff --git a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/formatter/DefaultCodeFormatterOptions.java b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/formatter/DefaultCodeFormatterOptions.java index dc6868739f5..33378fde3e6 100644 --- a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/formatter/DefaultCodeFormatterOptions.java +++ b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/formatter/DefaultCodeFormatterOptions.java @@ -2529,7 +2529,7 @@ public class DefaultCodeFormatterOptions { } /** - * Configure K&R style. + * Configure K&R style. *

    Example:

    * 
     	 * namespace foospace {
diff --git a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/formatter/IndentManipulation.java b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/formatter/IndentManipulation.java
index 4a6c3d17e29..2af58f14418 100644
--- a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/formatter/IndentManipulation.java
+++ b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/formatter/IndentManipulation.java
@@ -176,7 +176,7 @@ public final class IndentManipulation {
 	/**
 	 * Removes the given number of indentation units from a given line. If the line
 	 * has less than the given indent, all the available indentation is removed.
-	 * If indentsToRemove <= 0 the line is returned.
+	 * If indentsToRemove <= 0 the line is returned.
 	 *
 	 * @param line the line to trim
 	 * @param tabWidth the width of one tab in space equivalents
diff --git a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/resources/IPathEntryVariableManager.java b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/resources/IPathEntryVariableManager.java
index 24b78f8302e..b24812532d8 100644
--- a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/resources/IPathEntryVariableManager.java
+++ b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/resources/IPathEntryVariableManager.java
@@ -115,13 +115,13 @@ public interface IPathEntryVariableManager {
 	 * 
  • BACKUP = /tmp/backup
    • 
 	 *
*

The following paths would be resolved as: - *

c:/bin => c:/bin

- *

c:${TEMP} => c:/temp

- *

/TEMP => /TEMP

- *

${TEMP}/foo => /temp/foo

- *

${BACKUP} => /tmp/backup

- *

${BACKUP}/bar.txt => /tmp/backup/bar.txt

- *

SOMEPATH/foo => SOMEPATH/foo

+ *

c:/bin => c:/bin

+ *

c:${TEMP} => c:/temp

+ *

/TEMP => /TEMP

+ *

${TEMP}/foo => /temp/foo

+ *

${BACKUP} => /tmp/backup

+ *

${BACKUP}/bar.txt => /tmp/backup/bar.txt

+ *

SOMEPATH/foo => SOMEPATH/foo

* * @param path the path to be resolved * @return the resolved path or null diff --git a/core/org.eclipse.cdt.core/templateengine/org/eclipse/cdt/core/templateengine/process/processes/CreateResourceIdentifier.java b/core/org.eclipse.cdt.core/templateengine/org/eclipse/cdt/core/templateengine/process/processes/CreateResourceIdentifier.java index 9610fb333de..a82a236481d 100644 --- a/core/org.eclipse.cdt.core/templateengine/org/eclipse/cdt/core/templateengine/process/processes/CreateResourceIdentifier.java +++ b/core/org.eclipse.cdt.core/templateengine/org/eclipse/cdt/core/templateengine/process/processes/CreateResourceIdentifier.java @@ -22,7 +22,7 @@ import org.eclipse.core.runtime.IProgressMonitor; /** * Creates a template macro value that can be used as a pseudo-unique resource identifier. * It is based on the name of the application and is in the form of four capital letters. - * e.g. Helloworld => HELL + * e.g. Helloworld => HELL */ public class CreateResourceIdentifier extends ProcessRunner { diff --git a/core/org.eclipse.cdt.core/templateengine/org/eclipse/cdt/core/templateengine/process/processes/SetEnvironmentVariable.java b/core/org.eclipse.cdt.core/templateengine/org/eclipse/cdt/core/templateengine/process/processes/SetEnvironmentVariable.java index 6054a2d8124..90e63841108 100644 --- a/core/org.eclipse.cdt.core/templateengine/org/eclipse/cdt/core/templateengine/process/processes/SetEnvironmentVariable.java +++ b/core/org.eclipse.cdt.core/templateengine/org/eclipse/cdt/core/templateengine/process/processes/SetEnvironmentVariable.java @@ -36,15 +36,15 @@ import org.eclipse.core.runtime.IProgressMonitor; * A template process for setting an environment variable in all of the new project's * build configurations. E.g., * 
- *  <process type="org.eclipse.cdt.core.SetEnvironmentVariable">
- *      <simple name="projectName" value="$(projectName)"/>
- *      <complex-array name="variables">
- *          <element>
- *              <simple name="name" value="QMAKE"/>
- *              <simple name="value" value="$(qmake)"/>
- *          </element>
- *      </complex-array>
- *  </process>
+ *  <process type="org.eclipse.cdt.core.SetEnvironmentVariable">
+ *      <simple name="projectName" value="$(projectName)"/>
+ *      <complex-array name="variables">
+ *          <element>
+ *              <simple name="name" value="QMAKE"/>
+ *              <simple name="value" value="$(qmake)"/>
+ *          </element>
+ *      </complex-array>
+ *  </process>
  *
* This will create an environment variable called "QMAKE" and will set the value to * be the value entered in a field (called qmake) in the New Project wizard. diff --git a/core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/CommandLineUtil.java b/core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/CommandLineUtil.java index bac39b20cb6..5d91d7faa10 100644 --- a/core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/CommandLineUtil.java +++ b/core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/CommandLineUtil.java @@ -50,11 +50,11 @@ public class CommandLineUtil { * Parsing arguments in a shell style. i.e. * * 
-	 * ["a b c" d] -> [[a b c],[d]]
-	 * [a   d] -> [[a],[d]]
-	 * ['"quoted"'] -> [["quoted"]]
-	 * [\\ \" \a] -> [[\],["],[a]]
-	 * ["str\\str\a"] -> [[str\str\a]]
+	 * ["a b c" d] -> [[a b c],[d]]
+	 * [a   d] -> [[a],[d]]
+	 * ['"quoted"'] -> [["quoted"]]
+	 * [\\ \" \a] -> [[\],["],[a]]
+	 * ["str\\str\a"] -> [[str\str\a]]
 	 *
* * @param line @@ -166,11 +166,11 @@ public class CommandLineUtil { * Parsing arguments in a cmd style. i.e. * * 
-	 * ["a b c" d] -> [[a b c],[d]]
-	 * [a   d] -> [[a],[d]]
-	 * ['"quoted"'] -> [['quoted']]
-	 * [\\ \" \a] -> [[\\],["],[\a]]
-	 * ["str\\str\a"] -> [[str\\str\a]]
+	 * ["a b c" d] -> [[a b c],[d]]
+	 * [a   d] -> [[a],[d]]
+	 * ['"quoted"'] -> [['quoted']]
+	 * [\\ \" \a] -> [[\\],["],[\a]]
+	 * ["str\\str\a"] -> [[str\\str\a]]
 	 *
* * @param line diff --git a/core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/cdtvariables/CdtVariableResolver.java b/core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/cdtvariables/CdtVariableResolver.java index b5ec1ec381e..2138b69dfd1 100644 --- a/core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/cdtvariables/CdtVariableResolver.java +++ b/core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/cdtvariables/CdtVariableResolver.java @@ -69,7 +69,7 @@ public class CdtVariableResolver { /** * Converts list of strings to one string using given string as delimiter, - * i.e -> "string1:string2:string3" + * i.e -> "string1:string2:string3" * * @param value - list of strings to convert. * @param listDelimiter - delimiter.