diff options
author | Paul Pazderski | 2019-11-22 20:23:23 +0000 |
---|---|---|
committer | Paul Pazderski | 2019-11-22 21:08:24 +0000 |
commit | 52f489ee726a5e60319bf40620717581bd0b0435 (patch) | |
tree | b7abe88cdd4e33c805766f42c618e37f0e5d34d3 | |
parent | 5e10cc37deefc6d92f881b25b74c8e0038b74bf1 (diff) | |
download | eclipse.platform.text-52f489ee726a5e60319bf40620717581bd0b0435.tar.gz eclipse.platform.text-52f489ee726a5e60319bf40620717581bd0b0435.tar.xz eclipse.platform.text-52f489ee726a5e60319bf40620717581bd0b0435.zip |
Bug 548250 - Javadoc problems in platform.textI20191125-1800I20191125-0600I20191124-1800I20191124-0600I20191123-1800I20191123-1115I20191123-0600I20191123-0100
Change-Id: I84f9f4c00e81494dc69134e660e261fcab1dc493
Signed-off-by: Paul Pazderski <paul-eclipse@ppazderski.de>
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 b068ec71861..a192a65118d 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 <code>IFile<code>s.. + * optimized for <code>IFile</code>s.. * * @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 70ecd85bf59..134c59d4b0e 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 3bcaab28954..f08f6fa2f2c 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; * </p> * <p> * Current problems: + * </p> * <ul> * <li>the size computation is too small</li> * <li>focusLost event is not sent - see https://bugs.eclipse.org/bugs/show_bug.cgi?id=84532</li> * </ul> - * </p> * * @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 302648441c2..e41f75837ce 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 * <li>CONTEXT_SELECTOR * <li>PROPOSAL_SELECTOR * <li>CONTEXT_INFO_POPUP - * <ul> + * </ul> * @param type the listener type for which to acquire * @return <code>true</code> if the widget token could be acquired * @since 2.0 @@ -1114,7 +1114,7 @@ public class ContentAssistant2 implements IContentAssistant, IContentAssistantEx * <li>CONTEXT_SELECTOR * <li>PROPOSAL_SELECTOR * <li>CONTEXT_INFO_POPUP - * <ul> + * </ul> * 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 * <li>CONTEXT_SELECTOR * <li>PROPOSAL_SELECTOR * <li>CONTEXT_INFO_POPUP - * <ul> + * </ul> * * @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 163a7b689c1..386e01fa75e 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 <code>remaining</code>>= {@link #length()} or <code>remaining</code><t;= 0 + * @throws LineIndexOutOfBoundsException if <code>remaining</code>>= {@link #length()} or <code>remaining</code><= 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 181e79cf20b..d7be9207fa2 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. - * <p> - * 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. * <p> + * 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. * </p> + * <p> * Note: This sequence is ignored if the original anchor is not contained in this sequence. * </p> * 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 540c6e29538..8e1416deaff 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 { * * <p> * The returned label can have several values: + * </p> * <ul> * <li><code>null</code> when mining is not resolved</li> * <li><code>null</code> when mining is resolved means that mining was resolved with an error and it will not @@ -65,7 +66,6 @@ public interface ICodeMining { * <li>empty when mining is resolved means that mining will not be displayed</li> * <li>non empty when mining must be displayed</li> * </ul> - * </p> * * @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 38516f5d5c1..56d7e1de8d4 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 <code>null</code> - * @param asynchronous <true> if this content assistant should present the proposals + * @param asynchronous <code>true</code> if this content assistant should present the proposals * asynchronously, <code>false</code> 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 856b92764b8..3f5fb801be5 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 f4b1a8b22a1..b785782b8da 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 <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 + * <ul> + * <li>Cagatay Calli <ccalli@gmail.com> - [find/replace] retain caps when replacing - https://bugs.eclipse.org/bugs/show_bug.cgi?id=28949 + * <li>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 + * </ul> */ 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 a84c7cfb0d1..e06d823571e 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 4a8d7b54071..6cbe87da3dc 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 eb93bbcb589..8a6e3799c4c 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: * <ul> - * <li> "" -> [0,0] - * <li> "a" -> [0,1] - * <li> "\n" -> [0,1], [1,0] - * <li> "a\n" -> [0,2], [2,0] - * <li> "a\nb" -> [0,2], [2,1] - * <li> "a\nbc\n" -> [0,2], [2,3], [5,0] + * <li> "" -> [0,0] + * <li> "a" -> [0,1] + * <li> "\n" -> [0,1], [1,0] + * <li> "a\n" -> [0,2], [2,0] + * <li> "a\nb" -> [0,2], [2,1] + * <li> "a\nbc\n" -> [0,2], [2,3], [5,0] * </ul> * 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 e4cdbee1e5c..16a02d90e0f 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: * <ul> - * <li> "" -> [0,0] - * <li> "a" -> [0,1] - * <li> "\n" -> [0,1], [1,0] - * <li> "a\n" -> [0,2], [2,0] - * <li> "a\nb" -> [0,2], [2,1] - * <li> "a\nbc\n" -> [0,2], [2,3], [5,0] + * <li> "" -> [0,0] + * <li> "a" -> [0,1] + * <li> "\n" -> [0,1], [1,0] + * <li> "a\n" -> [0,2], [2,0] + * <li> "a\nb" -> [0,2], [2,1] + * <li> "a\nbc\n" -> [0,2], [2,3], [5,0] * </ul> * <p> * 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: * </p> * <p> - * <code>line.offset <= offset < line.offset + offset.length</code>. + * <code>line.offset <= offset < line.offset + offset.length</code>. * </p> * <p> * If <code>offset</code> 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 fc8a2f779bd..a582ec80657 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; * </p> * * <dl> - * <dt>show infos <i>(default: <tt>false</tt>)</i></dt> + * <dt>show infos <i>(default: <code>false</code>)</i></dt> * <dd>Whether INFO-level annotations should be shown as code minings.</dd> * - * <dt>show warnings <i>(default: <tt>false</tt>)</i></dt> + * <dt>show warnings <i>(default: <code>false</code>)</i></dt> * <dd>Whether WARNING-level annotations should be shown as code minings.</dd> * - * <dt>show errors <i>(default: <tt>false</tt>)</i></dt> + * <dt>show errors <i>(default: <code>false</code>)</i></dt> * <dd>Whether ERROR-level annotations should be shown as code minings.</dd> * - * <dt>Maximum annotations shown <i>(default: <tt>100</tt>)</i></dt> + * <dt>Maximum annotations shown <i>(default: <code>100</code>)</i></dt> * <dd>How many annotations should be shown at most as code minings. Mainly to prevent bad editor * performance.</dd> * </dl> 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 918e0adf80d..e5f4880798e 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= <word index in #PROPOSAL>" 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 822a1f1cf87..a204be5c44a 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 <code>null</code> * @return the escaped string or <code>null</code> if text was <code>null</code> |