From 193272f3aec864b399e5be6690b5810dbaf75505 Mon Sep 17 00:00:00 2001 From: Markus Schorn Date: Wed, 5 Jul 2006 12:15:33 +0000 Subject: [PATCH] Fixed javadoc problems --- .../.settings/org.eclipse.jdt.core.prefs | 14 ++++++++++- .../internal/corext/template/c/CContext.java | 9 +++---- .../corext/template/c/CContextType.java | 3 --- .../template/c/TranslationUnitContext.java | 9 +++---- .../ui/BaseCElementContentProvider.java | 2 -- .../cdt/internal/ui/DocumentInputStream.java | 2 +- .../ui/viewsupport/CElementImageProvider.java | 5 ---- .../viewsupport/ProblemsLabelDecorator.java | 7 ++++-- .../StandardCElementLabelProvider.java | 2 +- .../org/eclipse/cdt/ui/CodeGeneration.java | 14 ++++++----- .../cdt/ui/FunctionPrototypeSummary.java | 2 +- .../org/eclipse/cdt/ui/IFunctionSummary.java | 1 - .../eclipse/cdt/ui/IWorkingCopyManager.java | 2 +- .../eclipse/cdt/ui/PreferenceConstants.java | 8 ------- .../cdt/utils/ui/controls/ControlFactory.java | 24 +++++++++++-------- .../utils/ui/controls/RadioButtonsArea.java | 2 -- 16 files changed, 54 insertions(+), 52 deletions(-) diff --git a/core/org.eclipse.cdt.ui/.settings/org.eclipse.jdt.core.prefs b/core/org.eclipse.cdt.ui/.settings/org.eclipse.jdt.core.prefs index 78deee59e9e..e4258f3d61a 100644 --- a/core/org.eclipse.cdt.ui/.settings/org.eclipse.jdt.core.prefs +++ b/core/org.eclipse.cdt.ui/.settings/org.eclipse.jdt.core.prefs @@ -1,10 +1,22 @@ -#Mon Jul 03 10:04:50 CEST 2006 +#Wed Jul 05 13:45:48 CEST 2006 eclipse.preferences.version=1 org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=disabled org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.4 org.eclipse.jdt.core.compiler.compliance=1.4 +org.eclipse.jdt.core.compiler.doc.comment.support=enabled org.eclipse.jdt.core.compiler.problem.assertIdentifier=error org.eclipse.jdt.core.compiler.problem.enumIdentifier=warning +org.eclipse.jdt.core.compiler.problem.invalidJavadoc=warning +org.eclipse.jdt.core.compiler.problem.invalidJavadocTags=enabled +org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsDeprecatedRef=disabled +org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsNotVisibleRef=enabled +org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsVisibility=protected +org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore +org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled +org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public +org.eclipse.jdt.core.compiler.problem.missingJavadocTags=ignore +org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled +org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=protected org.eclipse.jdt.core.compiler.source=1.4 org.eclipse.jdt.core.formatter.align_type_members_on_columns=false org.eclipse.jdt.core.formatter.alignment_for_arguments_in_allocation_expression=16 diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/corext/template/c/CContext.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/corext/template/c/CContext.java index d17cd8dafaf..34726f758aa 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/corext/template/c/CContext.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/corext/template/c/CContext.java @@ -39,10 +39,11 @@ public class CContext extends TranslationUnitContext { /** * Creates a javadoc template context. * - * @param type the context type. - * @param string the document string. - * @param completionPosition the completion position within the document. - * @param unit the compilation unit (may be null). + * @param type the context type + * @param document the document + * @param completionOffset the completion position within the document + * @param completionLength the length of the context + * @param translationUnit the translation unit represented by the document */ public CContext(TemplateContextType type, IDocument document, int completionOffset, int completionLength, ITranslationUnit translationUnit) { diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/corext/template/c/CContextType.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/corext/template/c/CContextType.java index 3ad6f1e504b..80740349dbc 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/corext/template/c/CContextType.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/corext/template/c/CContextType.java @@ -22,9 +22,6 @@ public class CContextType extends TranslationUnitContextType { public final static String CCONTEXT_TYPE = "org.eclipse.cdt.ui.text.templates.c"; //$NON-NLS-1$ - /** - * @param name - */ public CContextType() { super(); // global diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/corext/template/c/TranslationUnitContext.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/corext/template/c/TranslationUnitContext.java index 368aa78777d..bbe3c27e735 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/corext/template/c/TranslationUnitContext.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/corext/template/c/TranslationUnitContext.java @@ -30,10 +30,11 @@ public abstract class TranslationUnitContext extends DocumentTemplateContext { /** * Creates a compilation unit context. * - * @param type the context type. - * @param string the document string. - * @param completionPosition the completion position within the document. - * @param compilationUnit the compilation unit (may be null). + * @param type the context type + * @param document the document + * @param completionOffset the completion position within the document + * @param completionLength the length of the context + * @param translationUnit the translation unit represented by the document */ protected TranslationUnitContext(TemplateContextType type, IDocument document, int completionOffset, int completionLength, ITranslationUnit translationUnit) diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/BaseCElementContentProvider.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/BaseCElementContentProvider.java index 6a099b38337..8fb6116f75f 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/BaseCElementContentProvider.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/BaseCElementContentProvider.java @@ -119,7 +119,6 @@ public class BaseCElementContentProvider implements ITreeContentProvider { /** * Can elements be group. - * @return */ public boolean areIncludesGroup() { return fIncludesGrouping; @@ -135,7 +134,6 @@ public class BaseCElementContentProvider implements ITreeContentProvider { /** * Can elements be group. - * @return */ public boolean areNamespacesGroup() { return fNamespacesGrouping; diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/DocumentInputStream.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/DocumentInputStream.java index 9f34e48ee2c..091bff74d34 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/DocumentInputStream.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/DocumentInputStream.java @@ -34,7 +34,7 @@ public class DocumentInputStream extends InputStream { } /** - * @see InputStream#read + * {@inheritDoc} */ public int read() throws IOException { try { diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/viewsupport/CElementImageProvider.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/viewsupport/CElementImageProvider.java index fd0c53d36fb..091e6253060 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/viewsupport/CElementImageProvider.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/viewsupport/CElementImageProvider.java @@ -127,11 +127,6 @@ public class CElementImageProvider { return null; } - /** - * - * @param type - * @return - */ public static ImageDescriptor getImageDescriptor(int type) { switch (type) { case ICElement.C_VCONTAINER: diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/viewsupport/ProblemsLabelDecorator.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/viewsupport/ProblemsLabelDecorator.java index 50cfda6d913..df890d276d9 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/viewsupport/ProblemsLabelDecorator.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/viewsupport/ProblemsLabelDecorator.java @@ -262,8 +262,11 @@ public class ProblemsLabelDecorator implements ILabelDecorator, ILightweightLabe // } /** - * Tests if a position is inside the source range of an element. - * @param pos Position to be tested. + * Tests if a position is inside the source range of an element. Usually this is done + * by looking at the offset. In case the offset equals -1, the line is + * tested. + * @param offSet offset to be tested + * @param line line to be tested * @param sourceElement Source element (must be a ICElement) * @return boolean Return true if position is located inside the source element. * @throws CoreException Exception thrown if element range could not be accessed. diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/viewsupport/StandardCElementLabelProvider.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/viewsupport/StandardCElementLabelProvider.java index e8fa897cab9..0b1a9625ebc 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/viewsupport/StandardCElementLabelProvider.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/viewsupport/StandardCElementLabelProvider.java @@ -24,7 +24,7 @@ public class StandardCElementLabelProvider extends AppearanceAwareLabelProvider /** * Constructor for StandardCElementLabelProvider. - * @see CElementLabelProvider#CElementLabelProvider + * @see CElementLabelProvider#CElementLabelProvider() */ public StandardCElementLabelProvider(int textFlags, int imageFlags) { super(textFlags, imageFlags); diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/CodeGeneration.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/CodeGeneration.java index 5b32b6f3104..8682c3c13f2 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/CodeGeneration.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/CodeGeneration.java @@ -10,10 +10,12 @@ *******************************************************************************/ package org.eclipse.cdt.ui; -import org.eclipse.cdt.core.model.ITranslationUnit; -import org.eclipse.cdt.internal.ui.codemanipulation.StubUtility; import org.eclipse.core.runtime.CoreException; +import org.eclipse.cdt.core.model.ITranslationUnit; + +import org.eclipse.cdt.internal.ui.codemanipulation.StubUtility; + /** * Class that offers access to the templates contained in the 'code generation' preference page. * @@ -26,7 +28,7 @@ public class CodeGeneration { /** * Returns the content for a new compilation unit using the 'new Java file' code template. - * @param cu The compilation to create the source for. The compilation unit does not need to exist. + * @param tu The translation unit to create the source for. The compilation unit does not need to exist. * @param typeComment The comment for the type to created. Used when the code template contains a ${typecomment} variable. Can be null if * no comment should be added. * @param typeContent The code of the type, including type declaration and body. @@ -40,7 +42,7 @@ public class CodeGeneration { /** * Returns the content for a new compilation unit using the 'new Java file' code template. - * @param cu The compilation to create the source for. The compilation unit does not need to exist. + * @param tu The translation unit to create the source for. The compilation unit does not need to exist. * @param typeComment The comment for the type to created. Used when the code template contains a ${typecomment} variable. Can be null if * no comment should be added. * @param typeContent The code of the type, including type declaration and body. @@ -54,9 +56,9 @@ public class CodeGeneration { /** * Returns the content for a new type comment using the 'typecomment' code template. The returned content is unformatted and is not indented. - * @param cu The compilation where the type is contained. The compilation unit does not need to exist. + * @param tu The translation unit where the type is contained. The compilation unit does not need to exist. * @param typeQualifiedName The name of the type to which the comment is added. For inner types the name must be qualified and include the outer - * types names (dot separated). See {@link org.eclipse.jdt.core.IType#getTypeQualifiedName(char)}. + * types names (dot separated). * @param lineDelimiter The line delimiter to be used. * @return Returns the new content or null if the code template is undefined or empty. The returned content is unformatted and is not indented. * @throws CoreException diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/FunctionPrototypeSummary.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/FunctionPrototypeSummary.java index 52ab08d6061..7547473e5cc 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/FunctionPrototypeSummary.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/FunctionPrototypeSummary.java @@ -21,7 +21,7 @@ public class FunctionPrototypeSummary implements IFunctionSummary.IFunctionProto /** * Create a function prototype summary based on a prototype string. - * @param The string describing the prototype which is properly + * @param proto The string describing the prototype which is properly * formed with following format -- returntype function(arguments) * The following formats will be converted as follows: * function(arguments) --> function(arguments) //constructors! diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IFunctionSummary.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IFunctionSummary.java index 1e3ab53996d..f56a0736e67 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IFunctionSummary.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IFunctionSummary.java @@ -44,7 +44,6 @@ public interface IFunctionSummary { * which depends on the variable namefirst * namefirst == true: main(int argc, char **argv) int * namefirst == false: int main(int argc, char **argv); - * @return */ public String getPrototypeString(boolean namefirst); } diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IWorkingCopyManager.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IWorkingCopyManager.java index 0c3bb6e4b29..62504bb4256 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IWorkingCopyManager.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IWorkingCopyManager.java @@ -30,7 +30,7 @@ import org.eclipse.ui.IEditorInput; * This interface is not intended to be implemented by clients. *

* - * @see JavaUI#getWorkingCopyManager + * @see CUIPlugin#getWorkingCopyManager */ public interface IWorkingCopyManager { diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/PreferenceConstants.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/PreferenceConstants.java index f5bf97842e6..dac9113b718 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/PreferenceConstants.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/PreferenceConstants.java @@ -185,8 +185,6 @@ public class PreferenceConstants { *

* Value is of type Boolean. *

- * - * @see #LINK_PACKAGES_TO_EDITOR */ public static final String BROWSING_LINK_VIEW_TO_EDITOR= "org.eclipse.cdt.ui.browsing.linktoeditor"; //$NON-NLS-1$ @@ -280,8 +278,6 @@ public class PreferenceConstants { *

* Value is of type Boolean. *

- * - * @see #LINK_PACKAGES_TO_EDITOR */ public static final String OUTLINE_GROUP_INCLUDES= "org.eclipse.cdt.ui.outline.groupincludes"; //$NON-NLS-1$ @@ -290,8 +286,6 @@ public class PreferenceConstants { *

* Value is of type Boolean. *

- * - * @see #LINK_PACKAGES_TO_EDITOR */ public static final String OUTLINE_GROUP_NAMESPACES= "org.eclipse.cdt.ui.outline.groupnamespaces"; //$NON-NLS-1$ @@ -300,8 +294,6 @@ public class PreferenceConstants { *

* Value is of type Boolean. *

- * - * @see #LINK_PACKAGES_TO_EDITOR */ public static final String CVIEW_GROUP_INCLUDES= "org.eclipse.cdt.ui.cview.groupincludes"; //$NON-NLS-1$ diff --git a/core/org.eclipse.cdt.ui/utils.ui/org/eclipse/cdt/utils/ui/controls/ControlFactory.java b/core/org.eclipse.cdt.ui/utils.ui/org/eclipse/cdt/utils/ui/controls/ControlFactory.java index 42cf48885c9..db906dbce62 100644 --- a/core/org.eclipse.cdt.ui/utils.ui/org/eclipse/cdt/utils/ui/controls/ControlFactory.java +++ b/core/org.eclipse.cdt.ui/utils.ui/org/eclipse/cdt/utils/ui/controls/ControlFactory.java @@ -95,11 +95,11 @@ public class ControlFactory { } /** - * Creates thick separator. + * Creates a separator. * * @param parent the parent of the new composite - * @param color the separator color - * @return preferedThickness - the prefered thickness of separator (or 2 if SWT.DEFAULT) + * @param nCols number of columns to span + * @return a separator label */ public static Label createSeparator(Composite parent, int nCols) { Label separator = new Label(parent, SWT.SEPARATOR | SWT.HORIZONTAL); @@ -326,9 +326,9 @@ public class ControlFactory { * Create a List box * * @param parent the parent of the new control - * @param label the group box label - * @param nColumns - number of layout columns - * @return the new group box + * @param strdata the data for the list, separated by commas + * @param selData - the item that shall be selected + * @return the new list box */ public static List createList(Composite parent, String strdata, String selData) { List list = new List(parent, SWT.SINGLE); @@ -478,7 +478,8 @@ public class ControlFactory { * Create a selection combo * * @param parent the parent of the new text field - * @param string of comma separated tokens to fill selection list + * @param strdata of comma separated tokens to fill selection list + * @param selData the item that shall be selected * @return the new combo */ public static CCombo createSelectCCombo(Composite parent, String strdata, String selData) { @@ -507,7 +508,8 @@ public class ControlFactory { * Create a selection combo * * @param parent the parent of the new text field - * @param array of elements + selected element + * @param strdata array of elements + * @param selData selected element * @return the new combo */ public static CCombo createSelectCCombo(Composite parent, String[] strdata, String selData) { @@ -548,7 +550,8 @@ public class ControlFactory { * Create a selection combo * * @param parent the parent of the new text field - * @param string of comma separated tokens to fill selection list + * @param strdata of comma separated tokens to fill selection list + * @param selData the item that shall be selected * @return the new combo */ public static Combo createSelectCombo(Composite parent, String strdata, String selData) { @@ -577,7 +580,8 @@ public class ControlFactory { * Create a selection combo * * @param parent the parent of the new text field - * @param array of elements + selected element + * @param strdata array of elements + * @param selData selected element * @return the new combo */ public static Combo createSelectCombo(Composite parent, String[] strdata, String selData) { diff --git a/core/org.eclipse.cdt.ui/utils.ui/org/eclipse/cdt/utils/ui/controls/RadioButtonsArea.java b/core/org.eclipse.cdt.ui/utils.ui/org/eclipse/cdt/utils/ui/controls/RadioButtonsArea.java index 3815178aeea..bca6661c065 100644 --- a/core/org.eclipse.cdt.ui/utils.ui/org/eclipse/cdt/utils/ui/controls/RadioButtonsArea.java +++ b/core/org.eclipse.cdt.ui/utils.ui/org/eclipse/cdt/utils/ui/controls/RadioButtonsArea.java @@ -104,8 +104,6 @@ public class RadioButtonsArea extends Composite { /** * Create control area - * - * @return nothing */ protected void createControl(Composite parent, String labelText) { GridLayout gl = new GridLayout();