From 52f489ee726a5e60319bf40620717581bd0b0435 Mon Sep 17 00:00:00 2001 From: Paul Pazderski Date: Fri, 22 Nov 2019 21:23:23 +0100 Subject: Bug 548250 - Javadoc problems in platform.text Change-Id: I84f9f4c00e81494dc69134e660e261fcab1dc493 Signed-off-by: Paul Pazderski --- .../internal/filebuffers/ResourceExtensionRegistry.java | 2 +- .../text/tests/reconciler/AbstractReconcilerTest.java | 5 ++--- .../internal/text/html/BrowserInformationControl.java | 2 +- .../text/link/contentassist/ContentAssistant2.java | 6 +++--- .../org/eclipse/jface/internal/text/revisions/Range.java | 2 +- .../jface/text/AbstractInformationControlManager.java | 10 +++++----- .../src/org/eclipse/jface/text/codemining/ICodeMining.java | 2 +- .../contentassist/ContentAssistSubjectControlAdapter.java | 2 +- .../jface/text/source/MatchingCharacterPainter.java | 2 +- .../search/internal/core/text/PatternConstructor.java | 6 ++++-- .../quicksearch/internal/core/priority/PrioriTree.java | 2 +- .../org/eclipse/jface/text/FindReplaceDocumentAdapter.java | 2 +- .../src/org/eclipse/jface/text/ListLineTracker.java | 12 ++++++------ .../src/org/eclipse/jface/text/TreeLineTracker.java | 14 +++++++------- .../annotation/AnnotationCodeMiningPreferences.java | 8 ++++---- .../tests/contributions/BarContentAssistProcessor.java | 2 +- .../eclipse/ui/texteditor/StatusLineContributionItem.java | 2 +- 17 files changed, 41 insertions(+), 40 deletions(-) diff --git a/org.eclipse.core.filebuffers/src/org/eclipse/core/internal/filebuffers/ResourceExtensionRegistry.java b/org.eclipse.core.filebuffers/src/org/eclipse/core/internal/filebuffers/ResourceExtensionRegistry.java index b068ec718..a192a6511 100644 --- a/org.eclipse.core.filebuffers/src/org/eclipse/core/internal/filebuffers/ResourceExtensionRegistry.java +++ b/org.eclipse.core.filebuffers/src/org/eclipse/core/internal/filebuffers/ResourceExtensionRegistry.java @@ -32,7 +32,7 @@ import org.eclipse.core.filebuffers.LocationKind; /** * This is a special {@link ExtensionsRegistry} that is - * optimized for IFiles.. + * optimized for IFiles.. * * @since 3.3 */ diff --git a/org.eclipse.jface.text.tests/src/org/eclipse/jface/text/tests/reconciler/AbstractReconcilerTest.java b/org.eclipse.jface.text.tests/src/org/eclipse/jface/text/tests/reconciler/AbstractReconcilerTest.java index 70ecd85bf..134c59d4b 100644 --- a/org.eclipse.jface.text.tests/src/org/eclipse/jface/text/tests/reconciler/AbstractReconcilerTest.java +++ b/org.eclipse.jface.text.tests/src/org/eclipse/jface/text/tests/reconciler/AbstractReconcilerTest.java @@ -45,11 +45,10 @@ import org.eclipse.jface.text.tests.TestTextViewer; * Reconciler tests. Uses barrier synchronization and a call log to assert * correct order of reconciling events. * - * TODO test reconciler arguments (delay > 0 etc.) - * TODO incremental reconciler tests - * * @since 3.1 */ +// TODO test reconciler arguments (delay > 0 etc.) +// TODO incremental reconciler tests public class AbstractReconcilerTest { /** diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/html/BrowserInformationControl.java b/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/html/BrowserInformationControl.java index 3bcaab289..f08f6fa2f 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/html/BrowserInformationControl.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/html/BrowserInformationControl.java @@ -64,11 +64,11 @@ import org.eclipse.jface.text.TextPresentation; *

*

* Current problems: + *

*
    *
  • the size computation is too small
    • *
  • focusLost event is not sent - see https://bugs.eclipse.org/bugs/show_bug.cgi?id=84532
    • *
- *

* * @since 3.2 */ diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/link/contentassist/ContentAssistant2.java b/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/link/contentassist/ContentAssistant2.java index 302648441..e41f75837 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/link/contentassist/ContentAssistant2.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/link/contentassist/ContentAssistant2.java @@ -1086,7 +1086,7 @@ public class ContentAssistant2 implements IContentAssistant, IContentAssistantEx *
  • CONTEXT_SELECTOR *
  • PROPOSAL_SELECTOR *
  • CONTEXT_INFO_POPUP - *
      + *
    * @param type the listener type for which to acquire * @return true if the widget token could be acquired * @since 2.0 @@ -1114,7 +1114,7 @@ public class ContentAssistant2 implements IContentAssistant, IContentAssistantEx *
  • CONTEXT_SELECTOR *
  • PROPOSAL_SELECTOR *
  • CONTEXT_INFO_POPUP - *
      + *
    * Returns whether the listener could be added successfully. A listener * can not be added if the widget token could not be acquired. * @@ -1169,7 +1169,7 @@ public class ContentAssistant2 implements IContentAssistant, IContentAssistantEx *
  • CONTEXT_SELECTOR *
  • PROPOSAL_SELECTOR *
  • CONTEXT_INFO_POPUP - *
      + *
    * * @param type the listener type * @since 2.0 diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/revisions/Range.java b/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/revisions/Range.java index 163a7b689..386e01fa7 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/revisions/Range.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/internal/text/revisions/Range.java @@ -232,7 +232,7 @@ public final class Range implements ILineRange, Cloneable { * * @param remaining the number of lines to remain in the receiver, must be in [1, {@link #length() length}) * @return the split off range - * @throws LineIndexOutOfBoundsException if remaining>= {@link #length()} or remaining<t;= 0 + * @throws LineIndexOutOfBoundsException if remaining>= {@link #length()} or remaining<= 0 */ public Range split(int remaining) throws LineIndexOutOfBoundsException { if (!(remaining < length())) // assert before modification diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/AbstractInformationControlManager.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/AbstractInformationControlManager.java index 181e79cf2..d7be9207f 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/AbstractInformationControlManager.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/AbstractInformationControlManager.java @@ -314,13 +314,13 @@ abstract public class AbstractInformationControlManager { private Anchor fAnchor= ANCHOR_BOTTOM; /** - * The anchor sequence used to layout the information control if the original anchor - * can not be used because the information control would not fit in the display client area. - *

    - * The fallback anchor for a given anchor is the one that comes directly after the given anchor or - * is the first one in the sequence if the given anchor is the last one in the sequence. + * The anchor sequence used to layout the information control if the original anchor can not be + * used because the information control would not fit in the display client area. *

    + * The fallback anchor for a given anchor is the one that comes directly after the given anchor + * or is the first one in the sequence if the given anchor is the last one in the sequence. *

    + *

    * Note: This sequence is ignored if the original anchor is not contained in this sequence. *

    * diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/codemining/ICodeMining.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/codemining/ICodeMining.java index 540c6e295..8e1416dea 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/codemining/ICodeMining.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/codemining/ICodeMining.java @@ -58,6 +58,7 @@ public interface ICodeMining { * *

    * The returned label can have several values: + *

    *
      *
    • null when mining is not resolved
      • *
    • null when mining is resolved means that mining was resolved with an error and it will not @@ -65,7 +66,6 @@ public interface ICodeMining { *
    • empty when mining is resolved means that mining will not be displayed
      • *
    • non empty when mining must be displayed
      • *
    - *

    * * @return the label may be set early in the class lifecycle, or upon completion of the future * provided by {@link #resolve(ITextViewer, IProgressMonitor)} operation. diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/ContentAssistSubjectControlAdapter.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/ContentAssistSubjectControlAdapter.java index 38516f5d5..56d7e1de8 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/ContentAssistSubjectControlAdapter.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/ContentAssistSubjectControlAdapter.java @@ -277,7 +277,7 @@ class ContentAssistSubjectControlAdapter implements IContentAssistSubjectControl * * @param contentAssistant the content assistant * @param controller the additional info controller, or null - * @param asynchronous if this content assistant should present the proposals + * @param asynchronous true if this content assistant should present the proposals * asynchronously, false otherwise * @return the completion proposal popup */ diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/MatchingCharacterPainter.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/MatchingCharacterPainter.java index 856b92764..3f5fb801b 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/MatchingCharacterPainter.java +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/MatchingCharacterPainter.java @@ -279,7 +279,7 @@ public final class MatchingCharacterPainter implements IPainter, PaintListener { * * @param sourceViewer the source viewer * @return a region denoting the current signed selection, for a resulting RtoL selections - * length is < 0 + * length is < 0 * @since 3.8 */ private static final IRegion getSignedSelection(ISourceViewer sourceViewer) { diff --git a/org.eclipse.search/search/org/eclipse/search/internal/core/text/PatternConstructor.java b/org.eclipse.search/search/org/eclipse/search/internal/core/text/PatternConstructor.java index f4b1a8b22..b785782b8 100644 --- a/org.eclipse.search/search/org/eclipse/search/internal/core/text/PatternConstructor.java +++ b/org.eclipse.search/search/org/eclipse/search/internal/core/text/PatternConstructor.java @@ -270,8 +270,10 @@ public class PatternConstructor { * Copied from {@link FindReplaceDocumentAdapter}} * * FindReplaceDocumentAdapter with contributions from: - * Cagatay Calli - [find/replace] retain caps when replacing - https://bugs.eclipse.org/bugs/show_bug.cgi?id=28949 - * Cagatay Calli - [find/replace] define & fix behavior of retain caps with other escapes and text before \C - https://bugs.eclipse.org/bugs/show_bug.cgi?id=217061 + *
      + *
    • Cagatay Calli <ccalli@gmail.com> - [find/replace] retain caps when replacing - https://bugs.eclipse.org/bugs/show_bug.cgi?id=28949 + *
    • Cagatay Calli <ccalli@gmail.com> - [find/replace] define & fix behavior of retain caps with other escapes and text before \C - https://bugs.eclipse.org/bugs/show_bug.cgi?id=217061 + *
    */ private static class ReplaceStringConstructor { diff --git a/org.eclipse.text.quicksearch/src/org/eclipse/text/quicksearch/internal/core/priority/PrioriTree.java b/org.eclipse.text.quicksearch/src/org/eclipse/text/quicksearch/internal/core/priority/PrioriTree.java index a84c7cfb0..e06d82357 100644 --- a/org.eclipse.text.quicksearch/src/org/eclipse/text/quicksearch/internal/core/priority/PrioriTree.java +++ b/org.eclipse.text.quicksearch/src/org/eclipse/text/quicksearch/internal/core/priority/PrioriTree.java @@ -178,7 +178,7 @@ public class PrioriTree extends DefaultPriorityFunction { /** * Locate tree node corresponding to a given path. - * @param fullPath + * @param path * @return The node or null if no corresponding node exists in the tree. */ private PrioriTree lookup(IPath path) { diff --git a/org.eclipse.text/src/org/eclipse/jface/text/FindReplaceDocumentAdapter.java b/org.eclipse.text/src/org/eclipse/jface/text/FindReplaceDocumentAdapter.java index 4a8d7b540..6cbe87da3 100644 --- a/org.eclipse.text/src/org/eclipse/jface/text/FindReplaceDocumentAdapter.java +++ b/org.eclipse.text/src/org/eclipse/jface/text/FindReplaceDocumentAdapter.java @@ -263,7 +263,7 @@ public class FindReplaceDocumentAdapter implements CharSequence { } /** - * Substitutes \R in a regex find pattern with (?>\r\n?|\n) + * Substitutes \R in a regex find pattern with {@code (?>\r\n?|\n)} * * @param findString the original find pattern * @return the transformed find pattern diff --git a/org.eclipse.text/src/org/eclipse/jface/text/ListLineTracker.java b/org.eclipse.text/src/org/eclipse/jface/text/ListLineTracker.java index eb93bbcb5..8a6e3799c 100644 --- a/org.eclipse.text/src/org/eclipse/jface/text/ListLineTracker.java +++ b/org.eclipse.text/src/org/eclipse/jface/text/ListLineTracker.java @@ -23,12 +23,12 @@ import org.eclipse.jface.text.AbstractLineTracker.DelimiterInfo; * line delimiters to subclasses. Assuming that '\n' is the only line delimiter, this abstract * implementation defines the following line scheme: *
      - *
    • "" -> [0,0] - *
    • "a" -> [0,1] - *
    • "\n" -> [0,1], [1,0] - *
    • "a\n" -> [0,2], [2,0] - *
    • "a\nb" -> [0,2], [2,1] - *
    • "a\nbc\n" -> [0,2], [2,3], [5,0] + *
    • "" -> [0,0] + *
    • "a" -> [0,1] + *
    • "\n" -> [0,1], [1,0] + *
    • "a\n" -> [0,2], [2,0] + *
    • "a\nb" -> [0,2], [2,1] + *
    • "a\nbc\n" -> [0,2], [2,3], [5,0] *
    * This class must be subclassed. * diff --git a/org.eclipse.text/src/org/eclipse/jface/text/TreeLineTracker.java b/org.eclipse.text/src/org/eclipse/jface/text/TreeLineTracker.java index e4cdbee1e..16a02d90e 100755 --- a/org.eclipse.text/src/org/eclipse/jface/text/TreeLineTracker.java +++ b/org.eclipse.text/src/org/eclipse/jface/text/TreeLineTracker.java @@ -27,12 +27,12 @@ import org.eclipse.jface.text.AbstractLineTracker.DelimiterInfo; * delimiters to subclasses. Assuming that '\n' is the only line delimiter, this abstract * implementation defines the following line scheme: *
      - *
    • "" -> [0,0] - *
    • "a" -> [0,1] - *
    • "\n" -> [0,1], [1,0] - *
    • "a\n" -> [0,2], [2,0] - *
    • "a\nb" -> [0,2], [2,1] - *
    • "a\nbc\n" -> [0,2], [2,3], [5,0] + *
    • "" -> [0,0] + *
    • "a" -> [0,1] + *
    • "\n" -> [0,1], [1,0] + *
    • "a\n" -> [0,2], [2,0] + *
    • "a\nb" -> [0,2], [2,1] + *
    • "a\nbc\n" -> [0,2], [2,3], [5,0] *
    *

    * This class must be subclassed. @@ -208,7 +208,7 @@ abstract class TreeLineTracker implements ILineTracker { * This means that for offsets smaller than the length, the following holds: *

    *

    - * line.offset <= offset < line.offset + offset.length. + * line.offset <= offset < line.offset + offset.length. *

    *

    * If offset is the document length, then this is true: diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/codemining/annotation/AnnotationCodeMiningPreferences.java b/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/codemining/annotation/AnnotationCodeMiningPreferences.java index fc8a2f779..a582ec806 100644 --- a/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/codemining/annotation/AnnotationCodeMiningPreferences.java +++ b/org.eclipse.ui.editors/src/org/eclipse/ui/internal/editors/text/codemining/annotation/AnnotationCodeMiningPreferences.java @@ -29,16 +29,16 @@ import org.eclipse.jface.preference.IPreferenceStore; *

    * *
    - *
    show infos (default: false)
    + *
    show infos (default: false)
    *
    Whether INFO-level annotations should be shown as code minings.
    * - *
    show warnings (default: false)
    + *
    show warnings (default: false)
    *
    Whether WARNING-level annotations should be shown as code minings.
    * - *
    show errors (default: false)
    + *
    show errors (default: false)
    *
    Whether ERROR-level annotations should be shown as code minings.
    * - *
    Maximum annotations shown (default: 100)
    + *
    Maximum annotations shown (default: 100)
    *
    How many annotations should be shown at most as code minings. Mainly to prevent bad editor * performance.
    *
    diff --git a/org.eclipse.ui.genericeditor.tests/src/org/eclipse/ui/genericeditor/tests/contributions/BarContentAssistProcessor.java b/org.eclipse.ui.genericeditor.tests/src/org/eclipse/ui/genericeditor/tests/contributions/BarContentAssistProcessor.java index 918e0adf8..e5f488079 100644 --- a/org.eclipse.ui.genericeditor.tests/src/org/eclipse/ui/genericeditor/tests/contributions/BarContentAssistProcessor.java +++ b/org.eclipse.ui.genericeditor.tests/src/org/eclipse/ui/genericeditor/tests/contributions/BarContentAssistProcessor.java @@ -68,7 +68,7 @@ public class BarContentAssistProcessor implements IContentAssistProcessor { } /** - * Creates context info "idx= " at the end of a word. + * Creates context info "idx= <word index in #PROPOSAL>" at the end of a word. **/ @Override public IContextInformation[] computeContextInformation(ITextViewer viewer, int offset) { diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/StatusLineContributionItem.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/StatusLineContributionItem.java index 822a1f1cf..a204be5c4 100644 --- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/StatusLineContributionItem.java +++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/StatusLineContributionItem.java @@ -269,7 +269,7 @@ public class StatusLineContributionItem extends ContributionItem implements ISta } /** - * Escapes '&' with '&' in the given text. + * Escapes '&' with '&' in the given text. * * @param text the text to escape, can be null * @return the escaped string or null if text was null -- cgit v1.2.1