From dd5cb9d7ed7be0c18abcb9817c4be1d064183b33 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Kubitz?= Date: Fri, 16 Feb 2024 11:00:05 +0100 Subject: [PATCH] ui: fix javadoc --- .../corext/buildpath/ClasspathModifier.java | 4 ++- .../corext/template/java/JavaContextType.java | 4 +-- .../corext/template/java/SWTContextType.java | 4 +-- .../ui/actions/FoldingActionGroup.java | 2 +- .../JavaElementReferenceConverter.java | 1 - .../internal/ui/dnd/JdtViewerDropAdapter.java | 1 - .../ui/dnd/ResourceTransferDragAdapter.java | 7 ++-- .../ConstantsForSystemPropertyCleanUp.java | 9 +++-- .../internal/ui/fix/LazyLogicalCleanUp.java | 4 +-- .../ui/fix/OperandFactorizationCleanUp.java | 6 ++-- .../ui/fix/RedundantModifiersCleanUp.java | 2 +- .../fix/StrictlyEqualOrDifferentCleanUp.java | 2 +- .../ui/fix/TernaryOperatorCleanUp.java | 2 +- .../ui/jarimport/JarImportWizard.java | 1 - .../ui/jarpackager/JarPackageWizard.java | 1 - .../internal/ui/javaeditor/JavaEditor.java | 4 +-- .../JavaSelectAnnotationRulerAction.java | 2 +- .../saveparticipant/IPostSaveListener.java | 4 +-- ...aveParticipantPreferenceConfiguration.java | 2 +- .../preferences/FilteredPreferenceTree.java | 1 - .../IPropertiesFilePartitions.java | 1 - .../PropertiesFileAutoEditStrategy.java | 1 - .../CompletionProposalComputerRegistry.java | 1 - .../ui/text/java/ContentAssistProcessor.java | 1 - ...umentNamesCompletionProposalCollector.java | 1 - .../PropertiesFileSpellCheckIterator.java | 5 ++- .../WordCompletionProposalComputer.java | 5 +-- .../engine/DefaultPhoneticHashProvider.java | 1 - .../ui/text/spelling/engine/package.html | 36 +++++++++---------- .../internal/ui/text/spelling/package.html | 6 ++-- .../internal/ui/util/ElementValidator.java | 2 +- .../jdt/internal/ui/util/PatternMatcher.java | 4 +-- .../jdt/internal/ui/util/ViewerPane.java | 1 - .../ui/wizards/NewTypeDropDownAction.java | 2 ++ .../ClasspathModifierQueries.java | 4 ++- 35 files changed, 61 insertions(+), 73 deletions(-) diff --git a/org.eclipse.jdt.ui/core extension/org/eclipse/jdt/internal/corext/buildpath/ClasspathModifier.java b/org.eclipse.jdt.ui/core extension/org/eclipse/jdt/internal/corext/buildpath/ClasspathModifier.java index 182fad83cfa..6a930f35124 100644 --- a/org.eclipse.jdt.ui/core extension/org/eclipse/jdt/internal/corext/buildpath/ClasspathModifier.java +++ b/org.eclipse.jdt.ui/core extension/org/eclipse/jdt/internal/corext/buildpath/ClasspathModifier.java @@ -857,7 +857,7 @@ public static void exclude(IPath path, List existingEntries, List * @param project the Java project * @param monitor progress monitor, can be null * - * @return the resulting IResource + * @return the resulting IResource */ public static IResource exclude(IJavaElement javaElement, CPListElement entry, IJavaProject project, IProgressMonitor monitor) { if (monitor == null) @@ -1031,8 +1031,10 @@ public static void commitClassPath(CPJavaProject cpProject, IProgressMonitor mon * * @param entries a list of entries to find an appropriate representation * for. The list can contain elements of two types: + *
    *
  • IResource
    • *
  • IJavaElement
    • + *
* @param project the Java project * @return a list of elements corresponding to the passed entries. */ diff --git a/org.eclipse.jdt.ui/core extension/org/eclipse/jdt/internal/corext/template/java/JavaContextType.java b/org.eclipse.jdt.ui/core extension/org/eclipse/jdt/internal/corext/template/java/JavaContextType.java index 45868ae127c..62e8ffe03f4 100644 --- a/org.eclipse.jdt.ui/core extension/org/eclipse/jdt/internal/corext/template/java/JavaContextType.java +++ b/org.eclipse.jdt.ui/core extension/org/eclipse/jdt/internal/corext/template/java/JavaContextType.java @@ -18,12 +18,12 @@ /** * The context type for templates inside Java code. * The same class is used for several context types: - *
+ *
    *
  • templates for all Java code locations
    • *
  • templates for member locations
    • *
  • templates for statement locations
    • *
  • templates for module-info.java files
    • - *
+ * */ public class JavaContextType extends AbstractJavaContextType { diff --git a/org.eclipse.jdt.ui/core extension/org/eclipse/jdt/internal/corext/template/java/SWTContextType.java b/org.eclipse.jdt.ui/core extension/org/eclipse/jdt/internal/corext/template/java/SWTContextType.java index 61374014bca..30427804e9e 100644 --- a/org.eclipse.jdt.ui/core extension/org/eclipse/jdt/internal/corext/template/java/SWTContextType.java +++ b/org.eclipse.jdt.ui/core extension/org/eclipse/jdt/internal/corext/template/java/SWTContextType.java @@ -18,11 +18,11 @@ /** * The context type for templates inside SWT code. * The same class is used for several context types: - *
+ *
    *
  • templates for all Java code locations
    • *
  • templates for member locations
    • *
  • templates for statement locations
    • - *
+ * * @since 3.4 */ public class SWTContextType extends AbstractJavaContextType { diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/actions/FoldingActionGroup.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/actions/FoldingActionGroup.java index 38cc3ac8525..3e43d3ca4a0 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/actions/FoldingActionGroup.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/actions/FoldingActionGroup.java @@ -198,7 +198,7 @@ public void run() { /** * Returns true if the group is enabled. * 
-	 * Invariant: isEnabled() <=> fViewer and all actions are != null.
+	 * Invariant: isEnabled() == fViewer and all actions are != null.
 	 *
* * @return true if the group is enabled diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/commands/JavaElementReferenceConverter.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/commands/JavaElementReferenceConverter.java index 3f0f8f2bd26..ccac855b498 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/commands/JavaElementReferenceConverter.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/commands/JavaElementReferenceConverter.java @@ -52,7 +52,6 @@ * * where parameterSignatures uses the signature format documented * in the {@link org.eclipse.jdt.core.Signature Signature} class. - *

* * @since 3.2 */ diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/dnd/JdtViewerDropAdapter.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/dnd/JdtViewerDropAdapter.java index 9c7f7a0e73a..61bfe3832f4 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/dnd/JdtViewerDropAdapter.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/dnd/JdtViewerDropAdapter.java @@ -40,7 +40,6 @@ * * The setFeedbackEnabled method can be called to turn on and off * visual insertion feedback (on by default). - *

*

* THIS IS (ALMOST) A ONE-TO-ONE COPY OF PLATFORMS ViewerDropAdapter * REFERE THERE FIRST IF YOU NEED TO FIX SOMETHING. diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/dnd/ResourceTransferDragAdapter.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/dnd/ResourceTransferDragAdapter.java index 62222dc09ec..cbf97f5dcea 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/dnd/ResourceTransferDragAdapter.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/dnd/ResourceTransferDragAdapter.java @@ -48,10 +48,9 @@ import org.eclipse.jdt.internal.ui.util.SWTUtil; /** - * A drag adapter that transfers the current selection as - * IResource. Only those elements in the selection are part - * of the transfer which can be converted into an IResource - * . + * A drag adapter that transfers the current selection as IResource. Only those + * elements in the selection are part of the transfer which can be converted into an + * IResource. */ public class ResourceTransferDragAdapter extends DragSourceAdapter implements TransferDragSourceListener { diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/ConstantsForSystemPropertyCleanUp.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/ConstantsForSystemPropertyCleanUp.java index fb326f3594b..044c769a9e3 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/ConstantsForSystemPropertyCleanUp.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/ConstantsForSystemPropertyCleanUp.java @@ -19,14 +19,13 @@ /** * A fix that replaces System.getProperty(xxx) by Java methods: *

*/ public class ConstantsForSystemPropertyCleanUp extends AbstractCleanUpCoreWrapper { diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/LazyLogicalCleanUp.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/LazyLogicalCleanUp.java index 2c78c526dbb..372575ca618 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/LazyLogicalCleanUp.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/LazyLogicalCleanUp.java @@ -44,8 +44,8 @@ /** * A fix that uses lazy logical operator when possible: *
    - *
  • Replaces & by &&,
    • - *
  • Replaces | by ||.
    • + *
  • Replaces {@code &} by {@code &&},
    • + *
  • Replaces {@code |} by {@code ||}.
    • *
*/ public class LazyLogicalCleanUp extends AbstractMultiFix { diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/OperandFactorizationCleanUp.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/OperandFactorizationCleanUp.java index edecf4bc559..a33fcb5f4d2 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/OperandFactorizationCleanUp.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/OperandFactorizationCleanUp.java @@ -45,7 +45,7 @@ import org.eclipse.jdt.ui.text.java.IProblemLocation; /** - * A fix that replaces (X && Y) || (X && Z) by (X && (Y || Z)): + * A fix that replaces {@code (X && Y) || (X && Z) by (X && (Y || Z))}: *
    *
  • The operators can be lazy or eager,
    • *
  • The factor operand must be passive and primitive,
    • @@ -54,7 +54,7 @@ *
* * Truth table: - * 
+ * 
{@code
    -------------------------------------------------------------------------------------------
    | a | b | c | (a && b) || (a && c) | a && (b || c) | (a || b) && (a || c) | a || (b && c) |
    | 0 | 0 | 0 |                    0 |             0 |                    0 |             0 |
@@ -66,7 +66,7 @@
    | 1 | 1 | 0 |                    1 |             1 |                    1 |             1 |
    | 1 | 1 | 1 |                    1 |             1 |                    1 |             1 |
    -------------------------------------------------------------------------------------------
-   

+   }
*/ public class OperandFactorizationCleanUp extends AbstractMultiFix { public OperandFactorizationCleanUp() { diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/RedundantModifiersCleanUp.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/RedundantModifiersCleanUp.java index 31291a9e069..34e55698093 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/RedundantModifiersCleanUp.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/RedundantModifiersCleanUp.java @@ -52,7 +52,7 @@ *
  • Within an interface modifiers public, static and final * are redundant for field declarations.
    • *
  • Within an interface modifier public and - * abstract + * abstract are redundant for method declarations.
    • *
  • Within a final class the final modifier is redundant for method * declarations.
    • *
  • For nested interfaces the static modifier is redundant.
    • diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/StrictlyEqualOrDifferentCleanUp.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/StrictlyEqualOrDifferentCleanUp.java index 7c03abd9b58..ebf8ccab55b 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/StrictlyEqualOrDifferentCleanUp.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/StrictlyEqualOrDifferentCleanUp.java @@ -49,7 +49,7 @@ import org.eclipse.jdt.ui.text.java.IProblemLocation; /** - * A fix that replaces (X && !Y) || (!X && Y) by X ^ Y: + * A fix that replaces <@code (X && !Y) || (!X && Y)} by <@code X ^ Y}: *
      *
    • Only works on boolean,
      • *
    • Works with lazy or eager operators,
      • diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/TernaryOperatorCleanUp.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/TernaryOperatorCleanUp.java index 10d4487a95d..b1b6af557ab 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/TernaryOperatorCleanUp.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/fix/TernaryOperatorCleanUp.java @@ -46,7 +46,7 @@ import org.eclipse.jdt.ui.text.java.IProblemLocation; /** - * A fix that replaces (X && Y) || (!X && Z) by X ? Y : Z: + * A fix that replaces <@code (X && Y) || (!X && Z)} by <@code X ? Y : Z}: *
        *
      • The operands must be passive and boolean.
        • *
      diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/jarimport/JarImportWizard.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/jarimport/JarImportWizard.java index 7e18ae36722..eb42a23242d 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/jarimport/JarImportWizard.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/jarimport/JarImportWizard.java @@ -80,7 +80,6 @@ * for associated refactorings, the wizard executes eventual refactorings, * copies the JAR file over its old version, the dialog closes, and the call to * open returns. - *

      * * @since 3.2 */ diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/jarpackager/JarPackageWizard.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/jarpackager/JarPackageWizard.java index 600ba2897d3..3ea48e28a1f 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/jarpackager/JarPackageWizard.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/jarpackager/JarPackageWizard.java @@ -70,7 +70,6 @@ * user. When the user hits Finish, the user-selected workspace resources * are exported to the user-specified zip file, the dialog closes, and the call * to open returns. - *

      */ public class JarPackageWizard extends Wizard implements IExportWizard { diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/javaeditor/JavaEditor.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/javaeditor/JavaEditor.java index 38ae06ef1a2..1372bf69f47 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/javaeditor/JavaEditor.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/javaeditor/JavaEditor.java @@ -1118,7 +1118,7 @@ protected void setCaretPosition(final int position) { * not its enclosing Java element. *
    • If the selection spans one or more partitions of the document, then all * partitions covered by the selection are entirely formatted.
      • - *

      + *

    * Partitions at the end of the selection are not completed, except for comments. * * @since 3.0 @@ -3822,7 +3822,7 @@ public ISelectionProvider getSelectionProvider() { * Returns the cached selected range, which allows * to query it from a non-UI thread. *

    - * The result might be outdated if queried from a non-UI thread.

    + * The result might be outdated if queried from a non-UI thread. * * @return the caret offset in the master document * @see ITextViewer#getSelectedRange() diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/javaeditor/JavaSelectAnnotationRulerAction.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/javaeditor/JavaSelectAnnotationRulerAction.java index bbd73438b44..b21c4e01caf 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/javaeditor/JavaSelectAnnotationRulerAction.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/javaeditor/JavaSelectAnnotationRulerAction.java @@ -50,7 +50,7 @@ * Action which gets triggered when selecting (annotations) in the vertical ruler. * *

    - * Was originally called >code>JavaSelectMarkerRulerAction. + * Was originally called JavaSelectMarkerRulerAction. *

    */ public class JavaSelectAnnotationRulerAction extends SelectMarkerRulerAction { diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/javaeditor/saveparticipant/IPostSaveListener.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/javaeditor/saveparticipant/IPostSaveListener.java index c8d4dba23e5..fc62b605980 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/javaeditor/saveparticipant/IPostSaveListener.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/javaeditor/saveparticipant/IPostSaveListener.java @@ -88,13 +88,13 @@ public interface IPostSaveListener { *
  • must not assume to be called in the UI thread
    • *
  • should be as fast as possible since this code is executed every time the compilationUnit is saved
    • * - * The compilation unit document provider can disable a listener that violates any of the above rules.

    + * The compilation unit document provider can disable a listener that violates any of the above rules. * * @param compilationUnit * the compilation unit which was saved * @param changedRegions * the regions where the compilationUnit has changed since the last save - * or null if requiresChangedRegions did return false. + * or null if requiresChangedRegions did return false. * The changed regions do not include changes introduced by other save participants. * @param monitor * the progress monitor for reporting progress diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/javaeditor/saveparticipant/ISaveParticipantPreferenceConfiguration.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/javaeditor/saveparticipant/ISaveParticipantPreferenceConfiguration.java index 0e08038c80f..02d432bfc8b 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/javaeditor/saveparticipant/ISaveParticipantPreferenceConfiguration.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/javaeditor/saveparticipant/ISaveParticipantPreferenceConfiguration.java @@ -89,7 +89,7 @@ public interface ISaveParticipantPreferenceConfiguration { /** * Called when a compilation unit is saved. - *

    + * * @param context the context in which the compilation unit is saved * @return true if the corresponding {@link IPostSaveListener} needs to be informed */ diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/preferences/FilteredPreferenceTree.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/preferences/FilteredPreferenceTree.java index ba82b65e75b..a14c6fac0e5 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/preferences/FilteredPreferenceTree.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/preferences/FilteredPreferenceTree.java @@ -68,7 +68,6 @@ *

  • pattern ~valueFilter
    • *
  • ~valueFilter pattern
    • * - *

    */ public class FilteredPreferenceTree { diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/propertiesfileeditor/IPropertiesFilePartitions.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/propertiesfileeditor/IPropertiesFilePartitions.java index 0073e6d2140..382e41fa0be 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/propertiesfileeditor/IPropertiesFilePartitions.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/propertiesfileeditor/IPropertiesFilePartitions.java @@ -46,7 +46,6 @@ public interface IPropertiesFilePartitions { /** * Array with properties file partitions. - * Value: {@value} */ String[] PARTITIONS= new String[] { COMMENT, PROPERTY_VALUE }; diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/propertiesfileeditor/PropertiesFileAutoEditStrategy.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/propertiesfileeditor/PropertiesFileAutoEditStrategy.java index 15bf57e7601..318fc46c688 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/propertiesfileeditor/PropertiesFileAutoEditStrategy.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/propertiesfileeditor/PropertiesFileAutoEditStrategy.java @@ -52,7 +52,6 @@ * {@link PropertiesFileEscapes#containsInvalidEscapeSequence(String)} *
  • a character which requires Unicode escapes
    • * - *

    * * @since 3.7 */ diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/java/CompletionProposalComputerRegistry.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/java/CompletionProposalComputerRegistry.java index 9a882499eea..922c60a0c63 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/java/CompletionProposalComputerRegistry.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/java/CompletionProposalComputerRegistry.java @@ -224,7 +224,6 @@ List getProposalComputerDescriptors() { * Returns the list of proposal categories contributed to the * javaCompletionProposalComputer extension point. *

    - *

    * The returned list is read-only and is sorted in the order that the extensions were read in. * There are no duplicate elements in the returned list. The returned list may change if * plug-ins are loaded or unloaded while the application is running. diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/java/ContentAssistProcessor.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/java/ContentAssistProcessor.java index 6ce0d6c80f3..df7b1876744 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/java/ContentAssistProcessor.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/java/ContentAssistProcessor.java @@ -93,7 +93,6 @@ * contexts are provided) *

  • getErrorMessage to change error reporting
    • * - *

    * * @since 3.2 */ diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/java/FillArgumentNamesCompletionProposalCollector.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/java/FillArgumentNamesCompletionProposalCollector.java index bfd826b9392..e74c36d941a 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/java/FillArgumentNamesCompletionProposalCollector.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/java/FillArgumentNamesCompletionProposalCollector.java @@ -37,7 +37,6 @@ *

    * This collector is used when * {@link PreferenceConstants#CODEASSIST_FILL_ARGUMENT_NAMES} is enabled. - *

    */ public final class FillArgumentNamesCompletionProposalCollector extends CompletionProposalCollector { diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/spelling/PropertiesFileSpellCheckIterator.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/spelling/PropertiesFileSpellCheckIterator.java index f3d59f31cac..a770afbb1b4 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/spelling/PropertiesFileSpellCheckIterator.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/spelling/PropertiesFileSpellCheckIterator.java @@ -13,9 +13,8 @@ *******************************************************************************/ package org.eclipse.jdt.internal.ui.text.spelling; -import java.util.Locale; - import java.text.BreakIterator; +import java.util.Locale; import org.eclipse.core.runtime.IProgressMonitor; @@ -25,7 +24,7 @@ /** * Iterator to spell check Java properties files - * where '&' is ignored. + * where {@code '&'} is ignored. * * @since 3.3 */ diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/spelling/WordCompletionProposalComputer.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/spelling/WordCompletionProposalComputer.java index da4a59a3be2..e8b4d8e34a7 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/spelling/WordCompletionProposalComputer.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/spelling/WordCompletionProposalComputer.java @@ -43,10 +43,7 @@ * Note: This is currently not supported because the spelling engine * cannot return word proposals but only correction proposals. *

    - * If we enable this again we must register the computer in plugin.xml: - * 

    - *
    - *

    + * If we enable this again we must register the computer in plugin.xml * * @since 3.0 */ diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/spelling/engine/DefaultPhoneticHashProvider.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/spelling/engine/DefaultPhoneticHashProvider.java index 989db8adeb0..e70756d9e27 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/spelling/engine/DefaultPhoneticHashProvider.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/spelling/engine/DefaultPhoneticHashProvider.java @@ -21,7 +21,6 @@ *

    * This algorithm uses an adapted version double metaphone algorithm by * Lawrence Philips. - *

    * * @since 3.0 */ diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/spelling/engine/package.html b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/spelling/engine/package.html index 6ecebe09e10..036be974965 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/spelling/engine/package.html +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/spelling/engine/package.html @@ -16,59 +16,59 @@

    spell-check iterators, or replaced by more specialized algorithms for a particular group of languages.

    Spell Check Engine

    -The central point to access the spell-checker functionality is the interface ISpellCheckEngine. +The central point to access the spell-checker functionality is the interface ISpellCheckEngine. Implementations of this interface provide support for life-cycle management, registering and unregistering dictionaries, changing the locale of the engine and creating a spell-checker for a specific language.

    The following steps are needed to obtain a spell-checker for a specific language:

      -
    • Create an instance of ISpellCheckEngine. In this package, no default implementation is provided, +
    • Create an instance of ISpellCheckEngine. In this package, no default implementation is provided, since the management of the dictionary registering and loading is application dependent. Usually, instances -of ISpellCheckEngine are implemented as singletons.
      • +of ISpellCheckEngine are implemented as singletons.
    • Create the appropriate dictionaries that should be used during the spell-check process. All dictionaries that -can be registered with ISpellCheckEngine must implement the interface ISpellCheckDictionary. -For this interface, an abstract implementation is provided in the class AbstractSpellDictionary. +can be registered with ISpellCheckEngine must implement the interface ISpellCheckDictionary. +For this interface, an abstract implementation is provided in the class AbstractSpellDictionary. Depending on the language of the words contained in this dictionary, custom algorithms for the phonetic hash - (IPhoneticHashProvider) and the edit distance (IPhoneticDistanceAlgorithm) should be implemented + (IPhoneticHashProvider) and the edit distance (IPhoneticDistanceAlgorithm) should be implemented and registered with the dictionary.
      • -
    • Instances of spell-checkers can now be created by calling createSpellChecker(Locale), where the locale +
    • Instances of spell-checkers can now be created by calling createSpellChecker(Locale), where the locale denotes the language that the spell-checker should use while executing.
    -When requesting a new spell-checker with a different locale via createSpellChecker(Locale), the spell-checker is +When requesting a new spell-checker with a different locale via createSpellChecker(Locale), the spell-checker is reconfigured with the new dictionaries. More concretely, the old dictionary is unregistered and a new one registered for the desired locale is associated with the spell-checker. If no such dictionary is available, no spell-checker is returned and the locale of the engine is reset to its default locale.

    Dictionaries

    Dictionaries are the data structures to hold word lists for a particular language. All implementations of dictionaries must -implement the interface ISpellDictionary. It provides support for life-cycle management as well as the facility to query +implement the interface ISpellDictionary. It provides support for life-cycle management as well as the facility to query words from the list, add words to the list and get correction proposals for incorrectly spelt words.

    -This package provides a default implementation of a dictionary (AbstractSpellDictionary) that uses algorithms +This package provides a default implementation of a dictionary (AbstractSpellDictionary) that uses algorithms convenient for english languages.
    Every dictionary needs two kinds of algorithms to be plugged in:

      -
    • An edit distance algorithm: Edit distance algorithms implement the interface IPhoneticDistanceAlgorithm. The algorithm -is used to determine the similarity between two words. This package provides a default implementation for languages using the latin alphabet (DefaultPhoneticDistanceAlgorithm). +
    • An edit distance algorithm: Edit distance algorithms implement the interface IPhoneticDistanceAlgorithm. The algorithm +is used to determine the similarity between two words. This package provides a default implementation for languages using the latin alphabet (DefaultPhoneticDistanceAlgorithm). The default algorithm uses the Levenshtein text edit distance.
      • -
    • A hash algorithm: Phonetic hash providers implement the interface IPhoneticHashProvider. The purpose of +
    • A hash algorithm: Phonetic hash providers implement the interface IPhoneticHashProvider. The purpose of phonetic hashes is to have a representation of words which allows comparing it to other, similar words. This package provides a default implementation which is convenient for slavic and english languages. It uses the double metaphone algorithm by published Lawrence Philips.
    -By plugging in custom implementations of one or both of these algorithms the abstract implementation AbstractSpellDictionary can +By plugging in custom implementations of one or both of these algorithms the abstract implementation AbstractSpellDictionary can be customized to specified languages and alphabets.

    Spell Check Iterators

    -Instances of ISpellChecker are usually language-, locale- and medium independent implementations and therefore need an input provider. The -interface ISpellCheckIterator serves this purpose by abstracting the tokenizing of text media to a simple iteration. The actual spell-check process -is launched by calling ISpellChecker#execute(ISpellCheckIterator). This method uses the indicated spell-check iterator to determine the +Instances of ISpellChecker are usually language-, locale- and medium independent implementations and therefore need an input provider. The +interface ISpellCheckIterator serves this purpose by abstracting the tokenizing of text media to a simple iteration. The actual spell-check process +is launched by calling ISpellChecker#execute(ISpellCheckIterator). This method uses the indicated spell-check iterator to determine the words that are to be spell-checked. This package provides no default implementation of a spell-check iterator.

    Event Handling

    To communicate the results of a spell-check pass, spell-checkers fire spell events that inform listeners about the status of a particular word being spell-checked. Instances that are interested in receiving spell events must implement -the interface ISpellEventListener and register with the spell-checker before the spell-check process starts.

    +the interface ISpellEventListener and register with the spell-checker before the spell-check process starts.

    A spell event contains the following information:

    • The word being spell-checked
      • diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/spelling/package.html b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/spelling/package.html index f880e28473d..936038e0f74 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/spelling/package.html +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/text/spelling/package.html @@ -20,14 +20,14 @@

      word completion proposals to the content assist processor.

      Spell-check engine

      -SpellCheckEngine is the default implementation of the interface ISpellCheckEngine. +SpellCheckEngine is the default implementation of the interface ISpellCheckEngine. It provides a facade for dealing with the setup of a spell-checker. This class provides methods to retrieve the available dictionaries and is responsible for the registration of those with the spell-checker. -SpellCheckEngine also has support for life-cycle management. Single dictionaries can be temporarily +SpellCheckEngine also has support for life-cycle management. Single dictionaries can be temporarily unloaded from memory or unregistered.
      To contribute own dictionaries use the methods to register locale sensitive or insensitive dictionaries. A dictionary can be associated to a specified locale, but can also be available for spell-checking arbitrary text in arbitrary languages. -The actual spell-checker for a specified language can then be obtained by calling createSpellChecker(Locale). +The actual spell-checker for a specified language can then be obtained by calling createSpellChecker(Locale). This is the central point to working with the spell-checker. When requesting a spell-checker for a specified locale, the engine looks up the corresponding dictionary and registers it with the spell-checker. Note that the dictionaries are lazily loaded and can be further optimized by prefiltering the queried words. diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/util/ElementValidator.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/util/ElementValidator.java index 70f952e6873..7355c2f3ee7 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/util/ElementValidator.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/util/ElementValidator.java @@ -37,7 +37,7 @@ import org.eclipse.jdt.internal.ui.JavaUIMessages; /** - * Helper class to check if a set of IJavaElement objects can be + * Helper class to check if a set of IJavaElement objects can be * modified by an operation. * * @since 2.1 diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/util/PatternMatcher.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/util/PatternMatcher.java index f403248d5ff..7322e0eb7fd 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/util/PatternMatcher.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/util/PatternMatcher.java @@ -15,12 +15,12 @@ import org.eclipse.jdt.core.search.SearchPattern; -import org.eclipse.jdt.internal.corext.util.SearchUtils; import org.eclipse.jdt.internal.core.manipulation.util.Strings; +import org.eclipse.jdt.internal.corext.util.SearchUtils; /** * A pattern matcher can match strings against various kinds of patterns supported by {@link SearchPattern}: - * Prefix, "*" and "?" patterns, camelCase, exact match with " " or "<" at the end of the pattern. + * Prefix, "*" and "?" patterns, camelCase, exact match with " " or {@code "<"} at the end of the pattern. * * @since 3.8 */ diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/util/ViewerPane.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/util/ViewerPane.java index 101d3a69e7e..44999f5e0ed 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/util/ViewerPane.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/util/ViewerPane.java @@ -25,7 +25,6 @@ /** * A ViewerPane is a convenience class which installs a * CLabel and a Toolbar in a ViewForm. - *

      */ public class ViewerPane extends ViewForm { diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/wizards/NewTypeDropDownAction.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/wizards/NewTypeDropDownAction.java index 0fbb50de906..c989e521fbe 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/wizards/NewTypeDropDownAction.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/wizards/NewTypeDropDownAction.java @@ -49,6 +49,7 @@ /** * A type wizard is added to the type drop down if it has a paramater 'javatype': + * 

      {@code
  *     
  *      
+ * }
      */ public class NewTypeDropDownAction extends Action implements IMenuCreator, IWorkbenchWindowPulldownDelegate2 { diff --git a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/wizards/buildpaths/newsourcepage/ClasspathModifierQueries.java b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/wizards/buildpaths/newsourcepage/ClasspathModifierQueries.java index 1d97f8902ef..39883bce8cb 100644 --- a/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/wizards/buildpaths/newsourcepage/ClasspathModifierQueries.java +++ b/org.eclipse.jdt.ui/ui/org/eclipse/jdt/internal/ui/wizards/buildpaths/newsourcepage/ClasspathModifierQueries.java @@ -33,13 +33,13 @@ import org.eclipse.jdt.core.IJavaProject; import org.eclipse.jdt.core.JavaModelException; +import org.eclipse.jdt.internal.core.manipulation.util.BasicElementLabels; import org.eclipse.jdt.internal.corext.util.Messages; import org.eclipse.jdt.ui.PreferenceConstants; import org.eclipse.jdt.ui.wizards.BuildPathDialogAccess; import org.eclipse.jdt.internal.ui.JavaPlugin; -import org.eclipse.jdt.internal.core.manipulation.util.BasicElementLabels; import org.eclipse.jdt.internal.ui.wizards.NewWizardMessages; import org.eclipse.jdt.internal.ui.wizards.buildpaths.CPListElement; import org.eclipse.jdt.internal.ui.wizards.buildpaths.ExclusionInclusionDialog; @@ -65,9 +65,11 @@ public static abstract class OutputFolderValidator { * * @param newElements a list of elements that will be added * to the buildpath. The list's items can be of type: + *
        *
      • IJavaProject
        • *
      • IPackageFragment
        • *
      • IFolder
        • + *
      * @param project the Java project */ public OutputFolderValidator(List newElements, IJavaProject project) throws JavaModelException {