Bug 559800 - Content in cdt.doc.isv badly outdated and broken

Fix javadoc tags.

Change-Id: I95a6720777797b4449509f29d00ce836a7c9e103
Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>

core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/model/ILanguage.java

@@ -44,7 +44,7 @@ public interface ILanguage extends IAdaptable {
 	public final static int OPTION_SKIP_FUNCTION_BODIES = 0x1;
 
 	/**
-	 * @deprecated, Has no effect.
+	 * @deprecated Has no effect.
 	 * @noreference This field is not intended to be referenced by clients.
 	 */
 	@Deprecated
@@ -58,7 +58,7 @@ public interface ILanguage extends IAdaptable {
 	public final static int OPTION_NO_IMAGE_LOCATIONS = 0x4;
 
 	/**
-	 * @deprecated, Has no effect.
+	 * @deprecated Has no effect.
 	 */
 	@Deprecated
 	public final static int OPTION_IS_SOURCE_UNIT = 0x8;

core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/model/IPathEntryContainerExtension.java

@@ -27,11 +27,11 @@ public interface IPathEntryContainerExtension extends IPathEntryContainer {
 	 * and empty array if none.
 	 *
 	 * @param path Workspace relative path.
-	 * @param typeMask type of path entries:
+	 * @param typesMask type of path entries:<ul>
 	 * <li><code>IPathEntry.CDT_INCLUDE</code></li>
 	 * <li><code>IPathEntry.CDT_INCLUDE_FILE</code></li>
 	 * <li><code>IPathEntry.CDT_MACRO_FILE</code></li>
-	 * <li><code>IPathEntry.CDT_MACRO</code></li>
+	 * <li><code>IPathEntry.CDT_MACRO</code></li></ul>
 	 * @return IPathEntry[] - the entries or empty set if none
 	 * @see IPathEntry
 	 */

core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/model/ITranslationUnit.java

@@ -169,7 +169,7 @@ public interface ITranslationUnit extends ICElement, IParent, IOpenable, ISource
 	/**
 	 * Creates and returns a namespace in this translation unit
 	 *
-	 * @param name the name of the namespace
+	 * @param namespace the name of the namespace
 	 * @param monitor the progress monitor to notify
 	 * @return the newly inserted namespace declaration (or the previously existing one in case
 	 *     attempting to create a duplicate)
@@ -189,8 +189,6 @@ public interface ITranslationUnit extends ICElement, IParent, IOpenable, ISource
 	 * <p>
 	 * Users of this method must not destroy the resulting working copy.
 	 *
-	 * @param bufferFactory
-	 *            the given {@code IBuffer} factory
 	 * @return the found shared working copy for this element, or {@code null} if none
 	 * @see IBufferFactory
 	 * @since 5.1
@@ -225,7 +223,7 @@ public interface ITranslationUnit extends ICElement, IParent, IOpenable, ISource
 	 * unit itself at the given position, or if the given position is not
 	 * within the source range of this translation unit.
 	 *
-	 * @param position a source position inside the translation unit
+	 * @param offset a source position inside the translation unit
 	 * @return the innermost C element enclosing a given source position or {@code null}
 	 *	   if none (excluding the translation unit).
 	 * @exception CModelException if the translation unit does not exist or if an
@@ -241,7 +239,7 @@ public interface ITranslationUnit extends ICElement, IParent, IOpenable, ISource
 	 * within the source range of this translation unit.
 	 * You have this behavior when at expansion of a macro.
 	 *
-	 * @param position a source position inside the translation unit
+	 * @param offset a source position inside the translation unit
 	 * @return the innermost C element enclosing a given source position or {@code null}
 	 *		if none (excluding the translation unit).
 	 * @exception CModelException if the translation unit does not exist or if an
@@ -254,7 +252,7 @@ public interface ITranslationUnit extends ICElement, IParent, IOpenable, ISource
 	/**
 	 * Returns the include declaration in this translation unit with the given name.
 	 *
-	 * @param the name of the include to find (For example: {@code "stdio.h"}
+	 * @param name the name of the include to find (For example: {@code "stdio.h"}
 	 * 		or {@code "sys/types.h"})
 	 * @return a handle onto the corresponding include declaration. The include declaration may or
 	 * 		may not exist.
@@ -519,7 +517,7 @@ public interface ITranslationUnit extends ICElement, IParent, IOpenable, ISource
 	Map<?, ?> parse();
 
 	/**
-	 * @deprecated, use {@link FileContent#create(ITranslationUnit)}, instead.
+	 * @deprecated Use {@link FileContent#create(ITranslationUnit)}, instead.
 	 * @noreference This method is not intended to be referenced by clients.
 	 */
 	@Deprecated

core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/model/IWorkingCopy.java

@@ -130,7 +130,7 @@ public interface IWorkingCopy extends ITranslationUnit {
 	 * @param forceProblemDetection  The boolean argument allows to force problem
 	 * 		detection even if the working copy is already consistent.
 	 * @param monitor  a progress monitor
-	 * @throw CModelException if the contents of the original element
+	 * @throws CModelException if the contents of the original element
 	 *		cannot be accessed
 	 */
 	void reconcile(boolean forceProblemDetection, IProgressMonitor monitor) throws CModelException;
@@ -157,7 +157,7 @@ public interface IWorkingCopy extends ITranslationUnit {
 	 * 		detection even if the working copy is already consistent.
 	 * @param monitor  a progress monitor
 	 * @return the AST or <code>null</code>
-	 * @throw CModelException if the contents of the original element
+	 * @throws CModelException if the contents of the original element
 	 *		cannot be accessed
 	 *
 	 * @since 4.0

core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICConfigurationDescription.java

@@ -234,10 +234,10 @@ 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 -> Configuration ID
+	 * @return Map<String,String> of referenced Project -&gt; Configuration ID
-	 * @see {@link #setReferenceInfo(Map)} <br/>
+	 * @see #setReferenceInfo(Map)
-	 * {@link #getExternalSettings()}<br/>
+	 * @see #getExternalSettings()
-	 * {@link #createExternalSetting(String[], String[], String[], ICSettingEntry[])}
+	 * @see #createExternalSetting(String[], String[], String[], ICSettingEntry[])
 	 */
 	Map<String, String> getReferenceInfo();
 

core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICSettingsStorage.java

@@ -56,7 +56,7 @@ public interface ICSettingsStorage {
 	 * the specified id an empty storage is created and returned
 	 * @throws CoreException
 	 *
-	 * @see {@link ICStorageElement}
+	 * @see ICStorageElement
 	 */
 	ICStorageElement getStorage(String id, boolean create) throws CoreException;
 

core/org.eclipse.cdt.core/options/org/eclipse/cdt/core/options/OptionStorage.java

@@ -51,7 +51,6 @@ public interface OptionStorage {
 	 * @param value to be saved, must not be <code>null</code>.
 	 * @param option the option metadata, must not be <code>null</code>.
 	 *
-	 * @return the option value or default value if option is unknown
 	 * @throws UnsupportedOperationException for unsupported option value types
 	 *
 	 * @see #consumable(Class)

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

@@ -15,7 +15,7 @@
 package org.eclipse.cdt.core.dom.ast;
 
 /**
- * @deprecated, use IASTMacroExpansionLocation instead
+ * @deprecated Use IASTMacroExpansionLocation instead
  * @noreference This interface is not intended to be referenced by clients.
  */
 @Deprecated

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

@@ -67,7 +67,7 @@ public interface IProblemBinding extends IBinding, IScope, IType, ISemanticProbl
 	public static final int SEMANTIC_INVALID_TEMPLATE_ARGUMENTS = BINDING_INVALID_TEMPLATE_ARGUMENTS;
 
 	/**
-	 * @deprecated, there may be additional problems.
+	 * @deprecated There may be additional problems.
 	 * @noreference This field is not intended to be referenced by clients.
 	 */
 	@Deprecated

core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPASTFunctionTryBlockDeclarator.java

@@ -17,7 +17,7 @@ package org.eclipse.cdt.core.dom.ast.cpp;
 import org.eclipse.cdt.core.dom.ast.ASTNodeProperty;
 
 /**
- * @deprecated, use {@link ICPPASTFunctionWithTryBlock}, instead.
+ * @deprecated Use {@link ICPPASTFunctionWithTryBlock}, instead.
  * @noreference This interface is not intended to be referenced by clients.
  */
 @Deprecated

core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPBasicType.java

@@ -22,7 +22,7 @@ import org.eclipse.cdt.core.dom.ast.IBasicType;
  */
 public interface ICPPBasicType extends IBasicType {
 	/**
-	 * @deprecated, don't use the constant, more flags may be added for supporting future c++ standards.
+	 * @deprecated Don't use the constant, more flags may be added for supporting future c++ standards.
 	 * @noreference This field is not intended to be referenced by clients.
 	 */
 	@Deprecated

core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPNodeFactory.java

@@ -391,7 +391,7 @@ public interface ICPPNodeFactory extends INodeFactory {
 	/**
 	 * Creates a new translation unit that cooperates with the given scanner in order
 	 * to track macro-expansions and location information.
-	 * @scanner the preprocessor the translation unit interacts with.
+	 * @param scanner the preprocessor the translation unit interacts with.
 	 * @since 5.2
 	 */
 	@Override

core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/cpp/ICPPTemplateNonTypeParameter.java

@@ -24,7 +24,7 @@ import org.eclipse.cdt.core.dom.ast.IASTExpression;
  */
 public interface ICPPTemplateNonTypeParameter extends ICPPTemplateParameter, ICPPVariable {
 	/**
-	 * @deprecated, use {@link ICPPTemplateParameter#getDefaultValue()}.
+	 * @deprecated Use {@link ICPPTemplateParameter#getDefaultValue()}.
 	 * @noreference This method is not intended to be referenced by clients.
 	 */
 	@Deprecated

core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/AbstractCLikeLanguage.java

@@ -102,13 +102,13 @@ public abstract class AbstractCLikeLanguage extends AbstractLanguage implements
 	}
 
 	/**
-	 * @returns the actual parser object.
+	 * @return the actual parser object.
 	 */
 	protected abstract ISourceCodeParser createParser(IScanner scanner, ParserMode parserMode,
 			IParserLogService logService, IIndex index);
 
 	/**
-	 * @returns the actual parser object, configured with additional settings.
+	 * @return the actual parser object, configured with additional settings.
 	 * @since 5.6
 	 */
 	protected ISourceCodeParser createParser(IScanner scanner, ParserMode parserMode, IParserLogService logService,

core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/IIndex.java

@@ -155,7 +155,7 @@ public interface IIndex {
 	 *
 	 * @param linkageID the id of the linkage in which the file has been parsed.
 	 * @param location the IIndexFileLocation representing the location of the file
-	 * @param macroDictionary The names and definitions of the macros used to disambiguate between
+	 * @param significantMacros The names and definitions of the macros used to disambiguate between
 	 *     variants of the file contents corresponding to different inclusion points.
 	 * @return the file for the location, or {@code null} if the file is not present in
 	 *     the index

core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/parser/util/IContentAssistMatcher.java

@@ -36,9 +36,9 @@ public interface IContentAssistMatcher {
 	char[] getPrefixForBinarySearch();
 
 	/**
-	 * @return If false, calling @{@link #match(char[])} can be skipped if a
+	 * @return If false, calling {@link #match(char[])} can be skipped if a
 	 *         name survived a binary search using the prefix returned by
-	 *         @{@link #getPrefixForBinarySearch()} as key.
+	 *         {@link #getPrefixForBinarySearch()} as key.
 	 */
 	boolean matchRequiredAfterBinarySearch();
 

core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/parser/util/SegmentMatcher.java

@@ -229,9 +229,9 @@ public class SegmentMatcher {
 	}
 
 	/**
-	 * @return If false, calling @{@link #match(char[])} can be skipped if a
+	 * @return If false, calling {@link #match(char[])} can be skipped if a
 	 *         name survived a binary search using the prefix returned by
-	 *         @{@link #getPrefixForBinarySearch()} as key.
+	 *         {@link #getPrefixForBinarySearch()} as key.
 	 */
 	public boolean matchRequiredAfterBinarySearch() {
 		return !singleSegment;

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

@@ -65,7 +65,7 @@ public interface IAddress extends Comparable<Object> {
 	/**
 	 * Returns whether this address equals the given object.
 	 *
-	 * @param obj the other object
+	 * @param addr the other object
 	 * @return <code>true</code> if the addresses are equivalent,
 	 *    and <code>false</code> if they are not
 	 */

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

@@ -45,8 +45,7 @@ public interface ICDescriptor {
 	 * in the project
 	 * @param extensionPointID String extensionPointID
 	 * @return ICExtensionReference[] ICExtensionReference array
-	 * @deprecated
+	 * @deprecated Use {@link ICConfigurationDescription#get(String)}
-	 * @use {@link ICConfigurationDescription#get(String)}
 	 */
 	@Deprecated
 	public ICExtensionReference[] get(String extensionPointID);
@@ -74,8 +73,7 @@ public interface ICDescriptor {
 	 * @param id
 	 * @return the create ICExtensionReference
 	 * @throws CoreException
-	 * @deprecated
+	 * @deprecated Use {@link ICConfigurationDescription#create(String, String)}
-	 * @use {@link ICConfigurationDescription#create(String, String)}
 	 */
 	@Deprecated
 	public ICExtensionReference create(String extensionPointID, String id) throws CoreException;
@@ -84,8 +82,7 @@ public interface ICDescriptor {
 	 * Remove a given ICExtensionReference from the project description.
 	 * @param extension
 	 * @throws CoreException
-	 * @deprecated
+	 * @deprecated Use {@link ICConfigurationDescription#remove(org.eclipse.cdt.core.settings.model.ICConfigExtensionReference)}
-	 * @use {@link ICConfigurationDescription#remove(org.eclipse.cdt.core.settings.model.ICConfigExtensionReference)}
 	 */
 	@Deprecated
 	public void remove(ICExtensionReference extension) throws CoreException;
@@ -95,8 +92,7 @@ public interface ICDescriptor {
 	 * this descriptor
 	 * @param extensionPoint
 	 * @throws CoreException
-	 * @deprecated
+	 * @deprecated Use {@link ICConfigurationDescription#remove(String)}
-	 * @use {@link ICConfigurationDescription#remove(String)}
 	 */
 	@Deprecated
 	public void remove(String extensionPoint) throws CoreException;
@@ -117,9 +113,8 @@ public interface ICDescriptor {
 	 * @param id an identifier that uniquely identifies the client
 	 * @return a non-null {@link Element} to which client specific meta-data may be attached
 	 * @throws CoreException
-	 * @deprecated
+	 * @deprecated Use {@link ICDescriptor#getProjectStorageElement(String)}
 	 * @noreference This method is not intended to be referenced by clients.
-	 * @use {@link ICDescriptor#getProjectStorageElement(String)}
 	 */
 	@Deprecated
 	public Element getProjectData(String id) throws CoreException;

core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/build/ICBuildConfiguration.java

@@ -188,8 +188,8 @@ public interface ICBuildConfiguration extends IAdaptable, IScannerInfoProvider {
 	 *
 	 * @param name
 	 *            the name of the property
-	 * @param the
+	 * @param value
-	 *            new value for the property
+	 *            the new value for the property
 	 * @since 6.4
 	 */
 	default void setProperty(String name, String value) {

core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/build/IToolChain.java

@@ -214,7 +214,7 @@ public interface IToolChain extends IAdaptable {
 	 *            info for
 	 * @param buildDirectoryURI
 	 *            the build directory that would be used to run commands
-	 * @returns default scanner info for this language
+	 * @return default scanner info for this language
 	 * @since 6.1
 	 */
 	default IExtendedScannerInfo getDefaultScannerInfo(IBuildConfiguration buildConfig,

core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/build/IToolChainManager.java

@@ -38,7 +38,7 @@ public interface IToolChainManager {
 	/**
 	 * Return the UI label for the toolchain type.
 	 *
-	 * @param id
+	 * @param typeId
 	 *            type toolchain type id
 	 * @return name of the type
 	 * @since 6.4

core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/formatter/DefaultCodeFormatterConstants.java

@@ -97,7 +97,6 @@ public class DefaultCodeFormatterConstants {
 	 *     - option id:         "org.eclipse.cdt.core.formatter.comment_formatter_on_tag"
 	 *     - default:           @formatter:on
 	 * </pre>
-	 * @see CCorePlugin#FORMAT_ON_TAG
 	 * @since 6.7
 	 */
 	public static final String FORMATTER_COMMENT_ON_TAG = CCorePlugin.PLUGIN_ID + ".formatter.comment_formatter_on_tag"; //$NON-NLS-1$
@@ -107,7 +106,6 @@ public class DefaultCodeFormatterConstants {
 	 *     - option id:         "org.eclipse.cdt.core.formatter.comment_formatter_off_tag"
 	 *     - default:           @formatter:off
 	 * </pre>
-	 * @see CCorePlugin#FORMAT_OFF_TAG
 	 * @since 6.7
 	 */
 	public static final String FORMATTER_COMMENT_OFF_TAG = CCorePlugin.PLUGIN_ID

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

@@ -36,7 +36,6 @@ public interface IPathEntryStore extends ICExtension {
 	 * Setting paths should fire a CONTENT_CHANGED events to the listeners.
 	 * It is up to the listener to calculate the deltas.
 	 *
-	 * @param project
 	 * @param entries
 	 * @throws CoreException
 	 */

core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/coff/Coff.java

@@ -27,7 +27,7 @@ import org.eclipse.cdt.core.CCorePlugin;
 import com.ibm.icu.text.DateFormat;
 
 /**
- * @deprecated. Deprecated as of CDT 6.9. Use 64 bit version {@link Coff64}.
+ * @deprecated Deprecated as of CDT 6.9. Use 64 bit version {@link Coff64}.
  * This class is planned for removal in next major release.
  */
 @Deprecated

core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/coff/PE.java

@@ -69,7 +69,7 @@ import org.eclipse.cdt.utils.debug.stabs.StabsReader;
  */
 
 /**
- * @deprecated. Deprecated as of CDT 6.9. Use 64 bit version {@link PE64}.
+ * @deprecated Deprecated as of CDT 6.9. Use 64 bit version {@link PE64}.
  * This class is planned for removal in next major release.
  */
 @Deprecated

core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/coff/parser/CygwinPEBinaryArchive.java

@@ -21,7 +21,7 @@ import org.eclipse.cdt.utils.AR.ARHeader;
 import org.eclipse.core.runtime.IPath;
 
 /**
- * @deprecated. Deprecated as of CDT 6.9. Use 64 bit version {@link CygwinPEBinaryArchive64}.
+ * @deprecated Deprecated as of CDT 6.9. Use 64 bit version {@link CygwinPEBinaryArchive64}.
  * This class is planned for removal in next major release.
  */
 @Deprecated

core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/coff/parser/CygwinPEBinaryExecutable.java

@@ -19,7 +19,7 @@ import org.eclipse.cdt.core.IBinaryParser.IBinaryFile;
 import org.eclipse.core.runtime.IPath;
 
 /**
- * @deprecated. Deprecated as of CDT 6.9. Use 64 bit version {@link CygwinPEBinaryExecutable64}.
+ * @deprecated Deprecated as of CDT 6.9. Use 64 bit version {@link CygwinPEBinaryExecutable64}.
  * This class is planned for removal in next major release.
  */
 @Deprecated

core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/coff/parser/CygwinPEBinaryObject.java

@@ -38,11 +38,8 @@ import org.eclipse.cdt.utils.coff.PE;
 import org.eclipse.core.runtime.IPath;
 import org.eclipse.core.runtime.Path;
 
-/*
- * CygwinPEBinaryObject
- */
 /**
- * @deprecated. Deprecated as of CDT 6.9. Use 64 bit version {@link CygwinPEBinaryObject64}.
+ * @deprecated Deprecated as of CDT 6.9. Use 64 bit version {@link CygwinPEBinaryObject64}.
  * This class is planned for removal in next major release.
  */
 @Deprecated

core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/coff/parser/CygwinPEBinaryShared.java

@@ -19,7 +19,7 @@ import org.eclipse.cdt.core.IBinaryParser.IBinaryShared;
 import org.eclipse.core.runtime.IPath;
 
 /**
- * @deprecated. Deprecated as of CDT 6.9. Use 64 bit version {@link CygwinPEBinaryShared64}.
+ * @deprecated Deprecated as of CDT 6.9. Use 64 bit version {@link CygwinPEBinaryShared64}.
  * This class is planned for removal in next major release.
  */
 @Deprecated

core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/coff/parser/CygwinPEParser.java

@@ -21,7 +21,7 @@ import org.eclipse.cdt.utils.ICygwinToolsFactroy;
 import org.eclipse.core.runtime.IPath;
 
 /**
- * @deprecated. Deprecated as of CDT 6.9. Use 64 bit version {@link CygwinPEParser64}.
+ * @deprecated Deprecated as of CDT 6.9. Use 64 bit version {@link CygwinPEParser64}.
  * This class is planned for removal in next major release.
  */
 @Deprecated

core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/coff/parser/CygwinSymbol.java

@@ -27,13 +27,7 @@ import org.eclipse.cdt.utils.Symbol;
 import org.eclipse.core.runtime.IPath;
 
 /**
- * @author DInglis
+ * @deprecated Deprecated as of CDT 6.9. Use 64 bit version {@link CygwinSymbol64}.
- *
- * To change the template for this generated type comment go to
- * Window>Preferences>Java>Code Generation>Code and Comments
- */
-/**
- * @deprecated. Deprecated as of CDT 6.9. Use 64 bit version {@link CygwinSymbol64}.
  * This class is planned for removal in next major release.
  */
 @Deprecated

core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/coff/parser/PEBinaryArchive.java

@@ -25,7 +25,7 @@ import org.eclipse.cdt.utils.BinaryFile;
 import org.eclipse.core.runtime.IPath;
 
 /**
- * @deprecated. Deprecated as of CDT 6.9. Use 64 bit version {@link PEBinaryArchive64}.
+ * @deprecated Deprecated as of CDT 6.9. Use 64 bit version {@link PEBinaryArchive64}.
  * This class is planned for removal in next major release.
  */
 @Deprecated

core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/coff/parser/PEBinaryExecutable.java

@@ -19,7 +19,7 @@ import org.eclipse.cdt.core.IBinaryParser.IBinaryFile;
 import org.eclipse.core.runtime.IPath;
 
 /**
- * @deprecated. Deprecated as of CDT 6.9. Use 64 bit version {@link PEBinaryExecutable64}.
+ * @deprecated Deprecated as of CDT 6.9. Use 64 bit version {@link PEBinaryExecutable64}.
  * This class is planned for removal in next major release.
  */
 @Deprecated

core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/coff/parser/PEBinaryObject.java

@@ -35,7 +35,7 @@ import org.eclipse.cdt.utils.coff.PE;
 import org.eclipse.core.runtime.IPath;
 
 /**
- * @deprecated. Deprecated as of CDT 6.9. Use 64 bit version {@link PEBinaryObject64}.
+ * @deprecated Deprecated as of CDT 6.9. Use 64 bit version {@link PEBinaryObject64}.
  * This class is planned for removal in next major release.
  */
 @Deprecated
@@ -54,9 +54,6 @@ public class PEBinaryObject extends BinaryObjectAdapter {
 		super(parser, p, type);
 	}
 
-	/* (non-Javadoc)
-	 * @see org.eclipse.cdt.utils.BinaryObjectAdapter#getName()
-	 */
 	@Override
 	public String getName() {
 		if (header != null) {
@@ -65,9 +62,6 @@ public class PEBinaryObject extends BinaryObjectAdapter {
 		return super.getName();
 	}
 
-	/* (non-Javadoc)
-	 * @see org.eclipse.cdt.core.IBinaryParser.IBinaryFile#getContents()
-	 */
 	@Override
 	public InputStream getContents() throws IOException {
 		if (getPath() != null && header != null) {
@@ -76,9 +70,6 @@ public class PEBinaryObject extends BinaryObjectAdapter {
 		return super.getContents();
 	}
 
-	/**
-	 * @see org.eclipse.cdt.core.IBinaryParser.IBinaryObject#getSymbols()
-	 */
 	@Override
 	public ISymbol[] getSymbols() {
 		if (hasChanged() || symbols == null) {
@@ -191,9 +182,6 @@ public class PEBinaryObject extends BinaryObjectAdapter {
 		}
 	}
 
-	/* (non-Javadoc)
-	 * @see org.eclipse.cdt.utils.BinaryObjectAdapter#getAddressFactory()
-	 */
 	@Override
 	public IAddressFactory getAddressFactory() {
 		if (addressFactory == null) {

core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/coff/parser/PEBinaryShared.java

@@ -19,7 +19,7 @@ import org.eclipse.cdt.core.IBinaryParser.IBinaryShared;
 import org.eclipse.core.runtime.IPath;
 
 /**
- * @deprecated. Deprecated as of CDT 6.9. Use 64 bit version {@link PEBinaryShared64}.
+ * @deprecated Deprecated as of CDT 6.9. Use 64 bit version {@link PEBinaryShared64}.
  * This class is planned for removal in next major release.
  */
 @Deprecated

core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/coff/parser/PEParser.java

@@ -27,23 +27,17 @@ import org.eclipse.cdt.utils.coff.PEConstants;
 import org.eclipse.core.runtime.IPath;
 
 /**
- * @deprecated. Deprecated as of CDT 6.9. Use 64 bit version {@link PEParser64}.
+ * @deprecated Deprecated as of CDT 6.9. Use 64 bit version {@link PEParser64}.
  * This class is planned for removal in next major release.
  */
 @Deprecated
 public class PEParser extends AbstractCExtension implements IBinaryParser {
 
-	/* (non-Javadoc)
-	 * @see org.eclipse.cdt.core.IBinaryParser#getBinary(org.eclipse.core.runtime.IPath)
-	 */
 	@Override
 	public IBinaryFile getBinary(IPath path) throws IOException {
 		return getBinary(null, path);
 	}
 
-	/* (non-Javadoc)
-	 * @see org.eclipse.cdt.core.IBinaryParser#getBinary(byte[], org.eclipse.core.runtime.IPath)
-	 */
 	@Override
 	public IBinaryFile getBinary(byte[] hints, IPath path) throws IOException {
 		if (path == null) {
@@ -92,17 +86,11 @@ public class PEParser extends AbstractCExtension implements IBinaryParser {
 		return binary;
 	}
 
-	/**
-	 * @see org.eclipse.cdt.core.IBinaryParser#getFormat()
-	 */
 	@Override
 	public String getFormat() {
 		return "PE"; //$NON-NLS-1$
 	}
 
-	/* (non-Javadoc)
-	 * @see org.eclipse.cdt.core.IBinaryParser#isBinary(byte[], org.eclipse.core.runtime.IPath)
-	 */
 	@Override
 	public boolean isBinary(byte[] array, IPath path) {
 		boolean isBin = PE.isExeHeader(array) || AR.isARHeader(array);
@@ -135,9 +123,6 @@ public class PEParser extends AbstractCExtension implements IBinaryParser {
 		return isBin;
 	}
 
-	/* (non-Javadoc)
-	 * @see org.eclipse.cdt.core.IBinaryParser#getHintBufferSize()
-	 */
 	@Override
 	public int getHintBufferSize() {
 		return 512;

core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/debug/IDebugEntryRequestor.java

@@ -69,7 +69,7 @@ public interface IDebugEntryRequestor {
 	/**
 	 * Statement in the compilation unit with a given address.
 	 * @param line lineno of the statement relative to the current compilation unit.
-	 * @param offset addres of the statement relative to the current function.
+	 * @param address address of the statement relative to the current function.
 	 */
 	void acceptStatement(int line, long address);
 
@@ -80,23 +80,16 @@ public interface IDebugEntryRequestor {
 
 	/**
 	 *  floating point constant.
-	 * @param name
-	 * @param value
 	 */
 	void acceptFloatConst(String name, double value);
 
 	/**
 	 * Type constant: "const b = 0", b is a type enum.
-	 * @param name
-	 * @param type
-	 * @param address
 	 */
 	void acceptTypeConst(String name, DebugType type, int value);
 
 	/**
 	 * Caught Exception.
-	 * @param name
-	 * @param value
 	 */
 	void acceptCaughtException(String name, DebugType type, long address);
 
@@ -111,10 +104,6 @@ public interface IDebugEntryRequestor {
 
 	/**
 	 * Record a variable.
-	 * @param name
-	 * @param type
-	 * @param kind
-	 * @param address
 	 */
 	void acceptVariable(String name, DebugType type, DebugVariableKind kind, long address);
 

core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/elf/parser/ElfBinaryArchive.java

@@ -38,9 +38,6 @@ public class ElfBinaryArchive extends BinaryFile implements IBinaryArchive {
 		children = new ArrayList<>(5);
 	}
 
-	/**
-	 * @see org.eclipse.cdt.core.IBinaryParser.IBinaryArchive#getObjects()
-	 */
 	@Override
 	public IBinaryObject[] getObjects() {
 		if (hasChanged()) {
@@ -71,7 +68,7 @@ public class ElfBinaryArchive extends BinaryFile implements IBinaryArchive {
 	}
 
 	/**
-	 * @deprecated use {@link ElfBinaryArchive#createArchiveMembers(ARHeader[])}
+	 * @deprecated use {@link #createArchiveMembers(ARHeader[])}
 	 */
 	@SuppressWarnings({ "unchecked", "rawtypes" })
 	@Deprecated

core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/macho/MachO.java

@@ -30,7 +30,7 @@ import org.eclipse.cdt.utils.debug.stabs.StabsReader;
 
 // test checkin
 /**
- * @deprecated. Deprecated as of CDT 6.1. Use 64 bit version {@link MachO64}.
+ * @deprecated Deprecated as of CDT 6.1. Use 64 bit version {@link MachO64}.
  * This class is planned for removal in next major release.
  */
 @Deprecated

core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/macho/MachOHelper.java

@@ -23,12 +23,12 @@ import org.eclipse.cdt.utils.macho.MachO.Section;
 import org.eclipse.cdt.utils.macho.MachO.Symbol;
 
 /**
- * @deprecated. Deprecated as of CDT 6.1. Use 64 bit version {@link MachOHelper64}.
- * This class is planned for removal in next major release.
- * <br>
  * <code>MachOHelper</code> is a wrapper class for the <code>MachO</code> class
  * to provide higher level API for sorting/searching the MachO data.
  *
+ * @deprecated Deprecated as of CDT 6.1. Use 64 bit version {@link MachOHelper64}.
+ * This class is planned for removal in next major release.
+ *
  *  @see MachO
  */
 @Deprecated

core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/macho/parser/MachOBinaryArchive.java

@@ -25,7 +25,7 @@ import org.eclipse.cdt.utils.macho.AR;
 import org.eclipse.core.runtime.IPath;
 
 /**
- * @deprecated. Deprecated as of CDT 6.1. Use 64 bit version {@link MachOBinaryArchive64}.
+ * @deprecated Deprecated as of CDT 6.1. Use 64 bit version {@link MachOBinaryArchive64}.
  * This class is planned for removal in next major release.
  */
 @Deprecated

core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/macho/parser/MachOBinaryExecutable.java

@@ -19,7 +19,7 @@ import org.eclipse.cdt.core.IBinaryParser.IBinaryFile;
 import org.eclipse.core.runtime.IPath;
 
 /**
- * @deprecated. Deprecated as of CDT 6.1. Use 64 bit version {@link MachOBinaryExecutable64}.
+ * @deprecated Deprecated as of CDT 6.1. Use 64 bit version {@link MachOBinaryExecutable64}.
  * This class is planned for removal in next major release.
  */
 @Deprecated

core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/macho/parser/MachOBinaryObject.java

@@ -40,7 +40,7 @@ import org.eclipse.core.runtime.IPath;
 import org.eclipse.core.runtime.Path;
 
 /**
- * @deprecated. Deprecated as of CDT 6.1. Use 64 bit version {@link MachOBinaryObject64}.
+ * @deprecated Deprecated as of CDT 6.1. Use 64 bit version {@link MachOBinaryObject64}.
  * This class is planned for removal in next major release.
  */
 @Deprecated

core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/macho/parser/MachOBinaryShared.java

@@ -19,7 +19,7 @@ import org.eclipse.cdt.core.IBinaryParser.IBinaryShared;
 import org.eclipse.core.runtime.IPath;
 
 /**
- * @deprecated. Deprecated as of CDT 6.1. Use 64 bit version {@link MachOBinaryShared64}.
+ * @deprecated Deprecated as of CDT 6.1. Use 64 bit version {@link MachOBinaryShared64}.
  * This class is planned for removal in next major release.
  */
 @Deprecated

core/org.eclipse.cdt.core/utils/org/eclipse/cdt/utils/macho/parser/MachOParser.java

@@ -27,15 +27,12 @@ import org.eclipse.core.runtime.IPath;
 import org.eclipse.core.runtime.Path;
 
 /**
- * @deprecated. Deprecated as of CDT 6.1. Use 64 bit version {@link MachOParser64}.
+ * @deprecated Deprecated as of CDT 6.1. Use 64 bit version {@link MachOParser64}.
  * This class is planned for removal in next major release.
  */
 @Deprecated
 public class MachOParser extends AbstractCExtension implements IBinaryParser {
 
-	/* (non-Javadoc)
-	 * @see org.eclipse.cdt.core.IBinaryParser#getBinary(org.eclipse.core.runtime.IPath)
-	 */
 	@Override
 	public IBinaryFile getBinary(IPath path) throws IOException {
 		return getBinary(null, path);
@@ -88,33 +85,21 @@ public class MachOParser extends AbstractCExtension implements IBinaryParser {
 		return binary;
 	}
 
-	/**
-	 * @see org.eclipse.cdt.core.IBinaryParser#getFormat()
-	 */
 	@Override
 	public String getFormat() {
 		return "MACHO"; //$NON-NLS-1$
 	}
 
-	/* (non-Javadoc)
-	 * @see org.eclipse.cdt.core.IBinaryParser#isBinary(byte[], org.eclipse.core.runtime.IPath)
-	 */
 	@Override
 	public boolean isBinary(byte[] array, IPath path) {
 		return MachO.isMachOHeader(array) || AR.isARHeader(array);
 	}
 
-	/* (non-Javadoc)
-	 * @see org.eclipse.cdt.core.IBinaryParser#getBufferSize()
-	 */
 	@Override
 	public int getHintBufferSize() {
 		return 128;
 	}
 
-	/* (non-Javadoc)
-	 * @see org.eclipse.cdt.utils.IGnuToolProvider#getCPPFilt()
-	 */
 	public CPPFilt getCPPFilt() {
 		IPath cppFiltPath = getCPPFiltPath();
 		CPPFilt cppfilt = null;