Fix usage or reserved symbols (<>&) in javadoc

Contributed by STMicroelectronics

Change-Id: Ifdf90e316d7537848bea8253973864f070b19b1c
Signed-off-by: Torbjörn Svensson <torbjorn.svensson@st.com>

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<String, Object> 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 =&gt; 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 =&gt; value map of the entries in subkey
 	 * @since 6.1
 	 */
 	public abstract Map<String, Object> getCurrentUserValues(String subkey);

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.
 	 *

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 <code>PTY(Mode.CONSOLE)</code>.
 	 */
 	public PTY() throws IOException {
 		this(Mode.CONSOLE);

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 &lt;...&gt;) entries are returned.
 	 *
 	 * @param cfgDescription - configuration description.
 	 * @param rc - resource such as file or folder.

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)}.
 	 * <br><br>
 	 * Note also that <b>you can compare these lists with simple equality operator ==</b>,
-	 * as the lists themselves are backed by WeakHashSet<List<ICLanguageSettingEntry>> where
+	 * as the lists themselves are backed by WeakHashSet&lt;List&lt;ICLanguageSettingEntry&gt;&gt; where
 	 * identical copies (deep comparison is used) are replaced with the same one instance.
 	 */
 	@Override

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&lt;-&gt;Build System settings integrity
 	 *
 	 * @return {@link ICProjectDescription} or null if the project does not contain the
 	 * CDT data associated with it.

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<String,String> of referenced Project -&gt; Configuration ID
+	 * @return Map&lt;String,String&gt; of referenced Project -&gt; 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 -&gt; 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()} <br/>

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&lt;-&gt;Build System settings integrity
 	 *
 	 * @return {@link ICProjectDescription} or null if the project does not contain the
 	 * CDT data associated with it.

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 <x.h>
+	 * "System" path is denoted by angle brackets as in #include &lt;x.h&gt;
 	 * "Local" path is denoted by quotes as in #include "x.h"
 	 */
 	int LOCAL = 1 << 2;

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:
 	 * <br>
 	 * 1. Loading configuration from external data source such as .cproject.<br>
-	 * 2. Loading preference configuration defined in Preferences -> C/C++ -> New project Wizard -> Makefile Project.
+	 * 2. Loading preference configuration defined in Preferences -&gt; C/C++ -&gt; New project Wizard -&gt; Makefile Project.
 	 *
 	 * @param cfgDescription - configuration description being loaded.
 	 * @param monitor - progress monitor.

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(<type-id>)
+ *     alignas(&lt;type-id&gt;)
- *     alignas(<expression>)
+ *     alignas(&lt;expression&gt;)
  *   C:
- *     _Alignas(<type-id>)
+ *     _Alignas(&lt;type-id&gt;)
- *     _Alignas(<expression>)
+ *     _Alignas(&lt;expression&gt;)
  * @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(<expression>)' or '_Alignas(<expression>)',
+	 * If the specifier is of the form 'alignas(&lt;expression&gt;)' or '_Alignas(&lt;expression&gt;)',
 	 * returns the enclosed expression. Otherwise, returns null.
 	 */
 	IASTExpression getExpression();
 
 	/**
-	 * If the specifier is of the form 'alignas(<type-id>)' or '_Alignas(<type-id>)',
+	 * If the specifier is of the form 'alignas(&lt;type-id&gt;)' or '_Alignas(&lt;type-id&gt;)',
 	 * returns the enclosed type-id. Otherwise, returns null.
 	 */
 	IASTTypeId getTypeId();

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 &lt;&lt;
 	 */
 	public static final int op_shiftLeft = 6;
 
 	/**
-	 * shift right >>
+	 * shift right &gt;&gt;
 	 */
 	public static final int op_shiftRight = 7;
 
 	/**
-	 * less than <
+	 * less than &lt;
 	 */
 	public static final int op_lessThan = 8;
 
 	/**
-	 * greater than >
+	 * greater than &gt;
 	 */
 	public static final int op_greaterThan = 9;
 
 	/**
-	 * less than or equals <=
+	 * less than or equals &lt;=
 	 */
 	public static final int op_lessEqual = 10;
 
 	/**
-	 * greater than or equals >=
+	 * greater than or equals &gt;=
 	 */
 	public static final int op_greaterEqual = 11;
 
 	/**
-	 * binary and &
+	 * binary and &amp;
 	 */
 	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 &amp;&amp;
 	 */
 	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 &lt;&lt;=
 	 */
 	public static final int op_shiftLeftAssign = 23;
 
 	/**
-	 * shift right assign >>=
+	 * shift right assign &gt;&gt;=
 	 */
 	public static final int op_shiftRightAssign = 24;
 
 	/**
-	 * binary and assign &=
+	 * binary and assign &amp;=
 	 */
 	public static final int op_binaryAndAssign = 25;
 
@@ -210,13 +210,13 @@ public interface IASTBinaryExpression extends IASTExpression {
 
 	/**
 	 * For g++, only.
-	 * <code>op_max</code> represents >?
+	 * <code>op_max</code> represents &gt;?
 	 */
 	public static final int op_max = 32;
 
 	/**
 	 * For g++, only.
-	 * <code>op_min</code> represents <?
+	 * <code>op_min</code> represents &lt;?
 	 */
 	public static final int op_min = 33;
 

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.

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
+ * 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
+ * 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.

core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTNode.java

@@ -63,7 +63,7 @@ public interface IASTNode {
 	 * <p>
 	 * 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 &gt; 1.
 	 * <p>
 	 * We do not provide meaningful node locations for nested macro references
 	 * (see {@link IASTPreprocessorMacroExpansion#getNestedMacroReferences()}).

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.

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;

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$
 
 	/**
-	 * <code>MAPPING_TYPE<ID/code> represents the pre-existing type id which
+	 * <code>MAPPING_TYPEID</code> represents the pre-existing type id which
 	 * the new symbol aliases.
 	 */
 	public static final ASTNodeProperty TARGET_TYPEID = new ASTNodeProperty(

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 {
 	/**
-	 * <code>op_dynamic_cast</code> is used for dynamic_cast<>'s.
+	 * <code>op_dynamic_cast</code> is used for dynamic_cast&lt;&gt;'s.
 	 */
 	public static final int op_dynamic_cast = IASTCastExpression.op_last + 1;
 
 	/**
-	 * <code>op_static_cast</code> is used for static_cast<>'s.
+	 * <code>op_static_cast</code> is used for static_cast&lt;&gt;'s.
 	 */
 	public static final int op_static_cast = IASTCastExpression.op_last + 2;
 
 	/**
-	 * <oode>op_reinterpret_cast</code> is used for reinterpret_cast<>'s.
+	 * <oode>op_reinterpret_cast</code> is used for reinterpret_cast&lt;&gt;'s.
 	 */
 	public static final int op_reinterpret_cast = IASTCastExpression.op_last + 3;
 
 	/**
-	 * <code>op_const_cast</code> is used for const_cast<>'s.
+	 * <code>op_const_cast</code> is used for const_cast&lt;&gt;'s.
 	 */
 	public static final int op_const_cast = IASTCastExpression.op_last + 4;
 

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 <code> auto f() -> int </code>, or <code>null</code>.
+	 * Returns the trailing return type as in <code> auto f() -gt; int </code>, or <code>null</code>.
 	 * @since 5.2
 	 */
 	public IASTTypeId getTrailingReturnType();
 
 	/**
-	 * Trailing return type as in <code> auto f() -> int </code>.
+	 * Trailing return type as in <code> auto f() -&gt; int </code>.
 	 * @since 5.2
 	 */
 	public void setTrailingReturnType(IASTTypeId typeId);

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. <code>int &&</code>).
+	 * Returns whether the operator denotes a rvalue reference (e.g. <code>int &amp;&amp;</code>).
 	 * @since 5.2
 	 */
 	public boolean isRValueReference();

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:
  * <ul>
  * <li><code>auto [x, y]{coordinate};</code></li>
- * <li><code>auto & [x, y](coordinate);</code></li>
+ * <li><code>auto &amp; [x, y](coordinate);</code></li>
- * <li><code>auto && [x, y] = createCoordinte();</code></li>
+ * <li><code>auto &amp;&amp; [x, y] = createCoordinte();</code></li>
  * </ul>
  *
  * @since 6.9
@@ -64,8 +64,8 @@ public interface ICPPASTStructuredBindingDeclaration
 	 * Examples:
 	 * <ul>
 	 * <li>For <code>auto [x, y] = coordinate;</code> it returns the empty <code>Optional</code></li>
-	 * <li>For <code>auto & [x, y] = coordinate;</code> it returns <code>Optional.of(RefQualifier.LVALUE)</code></li>
+	 * <li>For <code>auto &amp; [x, y] = coordinate;</code> it returns <code>Optional.of(RefQualifier.LVALUE)</code></li>
-	 * <li>For <code>auto && [x, y] = createCoordinte();</code> it returns <code>Optional.of(RefQualifier.RVALUE)</code></li>
+	 * <li>For <code>auto &amp;&amp; [x, y] = createCoordinte();</code> it returns <code>Optional.of(RefQualifier.RVALUE)</code></li>
 	 * </ul>
 	 *
 	 * @return The returned <code>RefQualifier</code> of the C++ declaration or <code>null</code> if there is no reference qualifier.
@@ -78,7 +78,7 @@ public interface ICPPASTStructuredBindingDeclaration
 	/**
 	 * Returns the list of names declared by this structured binding declaration.
 	 * <p>
-	 * Example: For <code>auto & [x, y] = coordinate;</code> it returns the names <code>x</code> and <code>y</code>.
+	 * Example: For <code>auto &amp; [x, y] = coordinate;</code> it returns the names <code>x</code> and <code>y</code>.
 	 *
 	 * @return All declared names of the structured binding as<code>IASTName[]</code>
 	 * @see IASTName
@@ -93,8 +93,8 @@ public interface ICPPASTStructuredBindingDeclaration
 	 *  * Examples:
 	 * <ul>
 	 * <li>For <code>auto [x, y]{coordinate};</code> it returns an <code>ICPPASTInitializerList</code></li>
-	 * <li>For <code>auto & [x, y](coordinate);</code> it returns an <code>ICPPASTConstructorInitializer</code></li>
+	 * <li>For <code>auto &amp; [x, y](coordinate);</code> it returns an <code>ICPPASTConstructorInitializer</code></li>
-	 * <li>For <code>auto && [x, y] = createCoordinte();</code> it returns an <code>IASTEqualsInitializer</code></li>
+	 * <li>For <code>auto &amp;&amp; [x, y] = createCoordinte();</code> it returns an <code>IASTEqualsInitializer</code></li>
 	 * </ul>
 	 *
 	 * @return The <code>IASTInitializer</code> of this structured binding. It can be <code>null</code> if the C++ declaration is lacking an initializer.

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 <code> V </code> in
- * <code>template&lttemplate&lttypename T&gt class V&gt class CT;</code>
+ * <code>template&lt;template&lt;typename T&gt; class V&gt; class CT;</code>
  *
  * @noextend This interface is not intended to be extended by clients.
  * @noimplement This interface is not intended to be implemented by clients.

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 T> class A {};     // the primary class template
+ * template &lt;class T&gt; class A {};     // the primary class template
- * template <class T> class A<T*> {}; // a partial specialization of the primary class template
+ * template &lt;class T&gt; class A&lt;T*&gt; {}; // 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.

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();

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;
  *
  * <code>
  * foo:
- *   void *labelPtr = &&foo;
+ *   void *labelPtr = &amp;&amp;foo;
  *   goto *labelPtr;
  * </code>
  *

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 {
 	/**
-	 * <code>PARAMETER_NAME</code> refers to the names qualified in a K&R C
+	 * <code>PARAMETER_NAME</code> refers to the names qualified in a K&amp;R C
 	 * function definition.
 	 */
 	public static final ASTNodeProperty PARAMETER_NAME = new ASTNodeProperty(
@@ -35,7 +35,7 @@ public interface ICASTKnRFunctionDeclarator extends IASTFunctionDeclarator {
 
 	/**
 	 * <code>FUNCTION_PARAMETER</code> represents the relationship between an
-	 * K&R function declarator and the full parameter declarations.
+	 * K&amp;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$

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 {
 	/**
-	 * <code>op_max</code> represents >?
+	 * <code>op_max</code> represents &gt;?
 	 */
 	public static final int op_max = IASTBinaryExpression.op_max;
 
 	/**
-	 * <code>op_min</code> represents <?
+	 * <code>op_min</code> represents &lt;?
 	 */
 	public static final int op_min = IASTBinaryExpression.op_min;
 

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.
 	 * <pre>
 	 * Example:
-	 *    addMacro("max(a,b)", "(((a)>(b) ? (a) : (b))");
+	 *    addMacro("max(a,b)", "(((a)&gt;(b) ? (a) : (b))");
 	 * </pre>
 	 * @param signature the signature of the macro, see {@link IMacro#getSignature()}.
 	 * @param value the macro value

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 <code>true</code> if support for K&R C should be enabled
+	 * @return <code>true</code> if support for K&amp;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:
 	 * <br>
-	 * void accelerate([proc=marsh] const Speed &data);
+	 * void accelerate([proc=marsh] const Speed &amp;data);
 	 * @since 5.1
 	 */
 	public boolean supportParameterInfoBlock();

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:
 	 * <br>
-	 * void accelerate([proc=marsh] const Speed &data);
+	 * void accelerate([proc=marsh] const Speed &amp;data);
 	 * @since 5.1
 	 */
 	public boolean supportParameterInfoBlock();

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 &lt; 0 or step &gt;= getExpansionStepCount().
 	 */
 	public abstract IMacroExpansionStep getExpansionStep(int step) throws IndexOutOfBoundsException;
 }

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
 	 * <br>
 	 * 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=&gt;[p1,p2,p3] will be present in the map
 	 * @return a mapping from string option to parameter string list
 	 */
 	protected Map<String, List<String>> getParsedArgs() {

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);
 

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.
 	 */

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

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<U> corresponding to a T in a Map<T, List<U>>. If the mapping doesn't exist,
+	 * Returns a List&lt;U&gt; corresponding to a T in a Map&lt;T, List&lt;U&gt;&gt;. If the mapping doesn't exist,
 	 * creates it with an empty list as the initial value.
 	 * @since 5.6
 	 */

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
+	 * newProject MUST, not be null, already have a C Nature && must
-	 * have a C++ Nature
+	 * 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&lt;-&gt;Build System settings integrity.
 	 *
 	 * @return {@link ICProjectDescription} or null if the project does not
 	 *         contain the CDT data associated with it.

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

core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ICExtensionReference.java

@@ -98,8 +98,8 @@ public interface ICExtensionReference {
 	 *
 	 * <pre>
 	 *  &lt;view&gt;
-	 *  &nbsp&nbsp&nbsp&nbsp&lt;verticalHint&gt;top&lt;/verticalHint&gt;
+	 *  &nbsp;&nbsp;&nbsp;&nbsp;&lt;verticalHint&gt;top&lt;/verticalHint&gt;
-	 *  &nbsp&nbsp&nbsp&nbsp&lt;horizontalHint&gt;left&lt;/horizontalHint&gt;
+	 *  &nbsp;&nbsp;&nbsp;&nbsp;&lt;horizontalHint&gt;left&lt;/horizontalHint&gt;
 	 *  &lt;/view&gt;
 	 * </pre>
 	 *

core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ISourceFinder.java

@@ -30,8 +30,8 @@ import org.eclipse.core.runtime.IAdaptable;
  * <p>
  * CDT has:
  * <ul>
- * <li>A global (common) source locator. Its containers are defined via Window > Preferences > C/C++ > Debug >
+ * <li>A global (common) source locator. Its containers are defined via Window &gt; Preferences &gt;
- * Source Lookup Path
+ * C/C++ &gt; Debug &gt; Source Lookup Path
  * <li>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.
  * <li>Launch source locators. Typically, a launch's locator is the one defined in the launch configuration

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:
-	 * "<value_1>< listDelimiter ><value_2>< listDelimiter > ... <value_n>"
+	 * "&lt;value_1&gt;&lt; listDelimiter &gt;&lt;value_2&gt;&lt; listDelimiter &gt; ... &lt;value_n&gt;"
 	 */
 	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
-	 * "<value_1>< listDelimiter ><value_2>< listDelimiter > ... <value_n>"
+	 * "&lt;value_1&gt;&lt; listDelimiter &gt;&lt;value_2&gt;&lt; listDelimiter &gt; ... &lt;value_n&gt;"
 	 * otherwise the BuildMacroException is thrown in case the string to be resolved references
 	 * string-list macros
 	 */

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>
+	 * 	&lt;New value&gt; = &lt;the value from the getValue() method&gt;&lt;delimiter&gt;&lt;Old value&gt;
 	 * For the "append" operation:
-	 * 	<New value> = <Old value><delimiter><the value from the getValue() method>
+	 * 	&lt;New value&gt; = &lt;Old value&gt;&lt;delimiter&gt;&lt;the value from the getValue() method&gt;
 	 *
 	 * The Environment Variable Provider will also remove the duplicates of "sub-values"
 	 * in the resulting value.

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<String, String> getKandRSettings() {
 		return DefaultCodeFormatterOptions.getKandRSettings().getMap();

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.
 	 * <p>Example:</p>
 	 * <pre>
 	 * namespace foospace {

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 <code>indentsToRemove <= 0</code> the line is returned.
+	 * If <code>indentsToRemove &lt;= 0</code> the line is returned.
 	 *
 	 * @param line the line to trim
 	 * @param tabWidth the width of one tab in space equivalents

core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/resources/IPathEntryVariableManager.java

@@ -115,13 +115,13 @@ public interface IPathEntryVariableManager {
 	 * <li>BACKUP = /tmp/backup</li>
 	 * </ul>
 	 * <p>The following paths would be resolved as:
-	 * <p>c:/bin => c:/bin</p>
+	 * <p>c:/bin =&gt; c:/bin</p>
-	 * <p>c:${TEMP} => c:/temp</p>
+	 * <p>c:${TEMP} =&gt; c:/temp</p>
-	 * <p>/TEMP => /TEMP</p>
+	 * <p>/TEMP =&gt; /TEMP</p>
-	 * <p>${TEMP}/foo  => /temp/foo</p>
+	 * <p>${TEMP}/foo  =&gt; /temp/foo</p>
-	 * <p>${BACKUP}  => /tmp/backup</p>
+	 * <p>${BACKUP}  =&gt; /tmp/backup</p>
-	 * <p>${BACKUP}/bar.txt  => /tmp/backup/bar.txt</p>
+	 * <p>${BACKUP}/bar.txt  =&gt; /tmp/backup/bar.txt</p>
-	 * <p>SOMEPATH/foo => SOMEPATH/foo</p></p>
+	 * <p>SOMEPATH/foo =&gt; SOMEPATH/foo</p></p>
 	 *
 	 * @param path the path to be resolved
 	 * @return the resolved path or <code>null</code>

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 {
 

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.,
  * <pre>
- *  &lt;process type="org.eclipse.cdt.core.SetEnvironmentVariable">
+ *  &lt;process type="org.eclipse.cdt.core.SetEnvironmentVariable"&gt;
- *      &lt;simple name="projectName" value="$(projectName)"/>
+ *      &lt;simple name="projectName" value="$(projectName)"/&gt;
- *      &lt;complex-array name="variables">
+ *      &lt;complex-array name="variables"&gt;
- *          &lt;element>
+ *          &lt;element&gt;
- *              &lt;simple name="name" value="QMAKE"/>
+ *              &lt;simple name="name" value="QMAKE"/&gt;
- *              &lt;simple name="value" value="$(qmake)"/>
+ *              &lt;simple name="value" value="$(qmake)"/&gt;
- *          &lt;/element>
+ *          &lt;/element&gt;
- *      &lt;/complex-array>
+ *      &lt;/complex-array&gt;
- *  &lt;/process>
+ *  &lt;/process&gt;
  * </pre>
  * 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.

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.
 	 *
 	 * <pre>
-	 * ["a b c" d] -> [[a b c],[d]]
+	 * ["a b c" d] -&gt; [[a b c],[d]]
-	 * [a   d] -> [[a],[d]]
+	 * [a   d] -&gt; [[a],[d]]
-	 * ['"quoted"'] -> [["quoted"]]
+	 * ['"quoted"'] -&gt; [["quoted"]]
-	 * [\\ \" \a] -> [[\],["],[a]]
+	 * [\\ \" \a] -&gt; [[\],["],[a]]
-	 * ["str\\str\a"] -> [[str\str\a]]
+	 * ["str\\str\a"] -&gt; [[str\str\a]]
 	 * </pre>
 	 *
 	 * @param line
@@ -166,11 +166,11 @@ public class CommandLineUtil {
 	 * Parsing arguments in a cmd style. i.e.
 	 *
 	 * <pre>
-	 * ["a b c" d] -> [[a b c],[d]]
+	 * ["a b c" d] -&gt; [[a b c],[d]]
-	 * [a   d] -> [[a],[d]]
+	 * [a   d] -&gt; [[a],[d]]
-	 * ['"quoted"'] -> [['quoted']]
+	 * ['"quoted"'] -&gt; [['quoted']]
-	 * [\\ \" \a] -> [[\\],["],[\a]]
+	 * [\\ \" \a] -&gt; [[\\],["],[\a]]
-	 * ["str\\str\a"] -> [[str\\str\a]]
+	 * ["str\\str\a"] -&gt; [[str\\str\a]]
 	 * </pre>
 	 *
 	 * @param line

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.