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>

6 files changed, 16 insertions, 18 deletions

diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/model/ILanguage.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/model/ILanguage.java
index 35d0131cf83..f186372e107 100644
--- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/model/ILanguage.java
+++ b/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;
diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/model/IPathEntryContainerExtension.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/model/IPathEntryContainerExtension.java
index 8ade9f05ecb..bc096b89283 100644
--- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/model/IPathEntryContainerExtension.java
+++ b/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
 	 */
diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/model/ITranslationUnit.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/model/ITranslationUnit.java
index e10e053ec14..e36825a75c0 100644
--- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/model/ITranslationUnit.java
+++ b/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
diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/model/IWorkingCopy.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/model/IWorkingCopy.java
index 25bdeae4e86..e58fac9fc6b 100644
--- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/model/IWorkingCopy.java
+++ b/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
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 8b874b914be..9bdc0a3ff55 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,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
-	 * @see {@link #setReferenceInfo(Map)} <br/>
-	 * {@link #getExternalSettings()}<br/>
-	 * {@link #createExternalSetting(String[], String[], String[], ICSettingEntry[])}
+	 * @return Map<String,String> of referenced Project -&gt; Configuration ID
+	 * @see #setReferenceInfo(Map)
+	 * @see #getExternalSettings()
+	 * @see #createExternalSetting(String[], String[], String[], ICSettingEntry[])
 	 */
 	Map<String, String> getReferenceInfo();
 
diff --git a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICSettingsStorage.java b/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICSettingsStorage.java
index d95c9e48ba0..6726e19b209 100644
--- a/core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/settings/model/ICSettingsStorage.java
+++ b/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;