diff options
| author | Alexander Kurtakov | 2019-02-16 10:06:56 +0000 |
|---|---|---|
| committer | Alexander Kurtakov | 2019-02-16 10:06:56 +0000 |
| commit | bd41efff8beecfdd9c83f1f3a8125177b474be9d (patch) | |
| tree | 9ba28c08b66dc157b677adb1f9bbdc348d57277e /org.eclipse.text | |
| parent | 3ca075b6da7f6baef7dfe36690bb3b1fa6fa6e58 (diff) | |
| download | eclipse.platform.text-bd41efff8beecfdd9c83f1f3a8125177b474be9d.tar.gz eclipse.platform.text-bd41efff8beecfdd9c83f1f3a8125177b474be9d.tar.xz eclipse.platform.text-bd41efff8beecfdd9c83f1f3a8125177b474be9d.zip | |
Bug 543933 - Build javadocs with Java 11I20190216-0600
Fix javadoc warnings catched by Java 11 tool with XDoclint:html.
Change-Id: Iac131bfc027cf0d7de92992b6518764ce0b568d9
Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>
Diffstat (limited to 'org.eclipse.text')
4 files changed, 43 insertions, 40 deletions
diff --git a/org.eclipse.text/src/org/eclipse/jface/text/IDocumentExtension3.java b/org.eclipse.text/src/org/eclipse/jface/text/IDocumentExtension3.java index 4285a774ab5..76dd81de491 100644 --- a/org.eclipse.text/src/org/eclipse/jface/text/IDocumentExtension3.java +++ b/org.eclipse.text/src/org/eclipse/jface/text/IDocumentExtension3.java @@ -69,6 +69,7 @@ public interface IDocumentExtension3 { * <code>false</code>, precedence is given to the partition that does not * end at <code>offset</code>. * </p> + * <p> * This is only supported if the connected <code>IDocumentPartitioner</code> * supports it, i.e. implements <code>IDocumentPartitionerExtension2</code>. * Otherwise, <code>preferOpenPartitions</code> is ignored. @@ -95,6 +96,7 @@ public interface IDocumentExtension3 { * <code>false</code>, precedence is given to the partition that does not * end at <code>offset</code>. * </p> + * <p> * This is only supported if the connected <code>IDocumentPartitioner</code> * supports it, i.e. implements <code>IDocumentPartitionerExtension2</code>. * Otherwise, <code>preferOpenPartitions</code> is ignored. @@ -120,6 +122,7 @@ public interface IDocumentExtension3 { * partition) is included between two closed partitions. If it is * <code>false</code>, no zero-length partitions are included. * </p> + * <p> * This is only supported if the connected <code>IDocumentPartitioner</code> * supports it, i.e. implements <code>IDocumentPartitionerExtension2</code>. * Otherwise, <code>includeZeroLengthPartitions</code> is ignored. diff --git a/org.eclipse.text/src/org/eclipse/jface/text/IDocumentPartitionerExtension2.java b/org.eclipse.text/src/org/eclipse/jface/text/IDocumentPartitionerExtension2.java index f5b89fa0688..15bda870050 100644 --- a/org.eclipse.text/src/org/eclipse/jface/text/IDocumentPartitionerExtension2.java +++ b/org.eclipse.text/src/org/eclipse/jface/text/IDocumentPartitionerExtension2.java @@ -79,10 +79,10 @@ public interface IDocumentPartitionerExtension2 { * <p> * If <code>preferOpenPartitions</code> is <code>true</code>, * precedence is given to an open partition ending at <code>offset</code> - * over a delimited partition starting at <code>offset</code>. + * over a delimited partition starting at <code>offset</code>.</p> * <p> * This method replaces {@link IDocumentPartitioner#getPartition(int)}and - * behaves like it when <preferOpenPartitions</code> is <code>false + * behaves like it when <code>preferOpenPartitions</code> is <code>false * </code>, i.e. precedence is always given to the partition that does not * end at <code>offset</code>. * </p> diff --git a/org.eclipse.text/src/org/eclipse/jface/text/package.html b/org.eclipse.text/src/org/eclipse/jface/text/package.html index cd18e104cb8..0adc4f9b151 100644 --- a/org.eclipse.text/src/org/eclipse/jface/text/package.html +++ b/org.eclipse.text/src/org/eclipse/jface/text/package.html @@ -7,22 +7,22 @@ <body> <p>Provides a framework for creating and manipulating text documents.</p> <h2>Package Specification</h2> -<p><tt>IDocument</tt> is the major text +<p><code>IDocument</code> is the major text model abstraction. It provides content management, position management using position categories, document partition management, and change notification. - In order to be notified about document changes, an object must implements <tt>IDocumentListener - </tt>and must be registered with the document. <tt>Position</tt> - updating in responds to a document change is performed by implementers of <tt>IDocumentPositionUpdater</tt>. + In order to be notified about document changes, an object must implements <code>IDocumentListener + </code>and must be registered with the document. <code>Position</code> + updating in responds to a document change is performed by implementers of <code>IDocumentPositionUpdater</code>. Partition updating in responds to a document change is performed by implements - of <tt>IDocumentPartitioner</tt>. In order - to be notified about document partition changes, objects must implement <tt>IDocumentParititoningListener</tt> + of <code>IDocumentPartitioner</code>. In order + to be notified about document partition changes, objects must implement <code>IDocumentParititoningListener</code> and must be registered with the document.</p> <p>The package contains default implementations for document position updaters - and for documents. <tt>AbstractDocument</tt> - uses <tt>ITextStorage</tt> for storing - and managing its content and <tt>ILineTracker</tt> + and for documents. <code>AbstractDocument</code> + uses <code>ITextStorage</code> for storing + and managing its content and <code>ILineTracker</code> to maintain a line structure of its content. As defaults a gap text implementation - of <tt>ITextStore</tt> is provided, together + of <code>ITextStore</code> is provided, together with a line tracker understanding the three standard line delimiters ("\r", "\n", "\r\n") and a line tracker which can be freely configured to consider any given set of strings as valid line delimiters. </p> @@ -32,20 +32,20 @@ <!-- Below is the package documentation for org.eclipse.jface.text from the org.eclipse.jface.text plug-in --> <!-- ===================================================================================================== --> -<p><tt>ITextViewer</tt> defines the concept of a document based, editiable viewer. - <tt>ITextViewer</tt> offers the following functionality: </p> +<p><code>ITextViewer</code> defines the concept of a document based, editiable viewer. + <code>ITextViewer</code> offers the following functionality: </p> <ul> <li> present a document</li> <li> -event consumption (<tt>IEventConsumer</tt>)</li> +event consumption (<code>IEventConsumer</code>)</li> <li> -viewport tracking and notification (<tt>IIViewportListener</tt>)</li> +viewport tracking and notification (<code>IIViewportListener</code>)</li> <li> -change notification (<tt>ITextListener</tt>, <tt>ITextInputListener</tt>)</li> +change notification (<code>ITextListener</code>, <code>ITextInputListener</code>)</li> <li> listeners (combined view/model notification, input document)</li> @@ -60,18 +60,18 @@ visual region support</li> An <code>ITextViewer</code> supports the following plug-ins <ul> <li> -<tt>IUndoManager</tt> for the undo/redo mechanism</li> +<code>IUndoManager</code> for the undo/redo mechanism</li> <li> -<tt>IDoubleClickStrategy</tt> for partition type specific behavior on mouse +<code>IDoubleClickStrategy</code> for partition type specific behavior on mouse double click</li> <li> -<tt>IAutoIndentStrategy</tt> for content type specific behavior on +<code>IAutoIndentStrategy</code> for content type specific behavior on inserting a line break</li> <li> -<tt>ITextHover</tt> for content type specific behavior when overing over +<code>ITextHover</code> for content type specific behavior when overing over text</li> </ul> The package provides default implementations for all these interfaces. diff --git a/org.eclipse.text/src/org/eclipse/jface/text/templates/package.html b/org.eclipse.text/src/org/eclipse/jface/text/templates/package.html index 00fe64dc3dc..32445271754 100644 --- a/org.eclipse.text/src/org/eclipse/jface/text/templates/package.html +++ b/org.eclipse.text/src/org/eclipse/jface/text/templates/package.html @@ -32,7 +32,7 @@ which are only resolved at the time when the template is inserted within a context. Together with linked mode, inserting a template can create a on-the-fly edit mask within a text viewer.<br> <br> -Templates are specified as text, variables are defined using the <tt>${variable}</tt> +Templates are specified as text, variables are defined using the <code>${variable}</code> notation known from Ant, for example. The following snippet shows an example template for an instance check in Java:<br> @@ -41,40 +41,40 @@ an instance check in Java:<br> ${cursor} } </pre> -In this template, the variables (<tt>name,type, ...</tt>) are resolved +In this template, the variables (<code>name,type, ...</code>) are resolved when inserted into java source and changing one variable instance will also change the other. When leaving linked mode, the caret is placed at -the <tt>cursor</tt> variable.<br> +the <code>cursor</code> variable.<br> <br> Template functionality can be added to a custom text editor by offering -<tt>TemplateProposal</tt>s as content assist choices, which is -simplified by using a subclass of <tt>TemplateCompletionProcessor</tt>. User template management can be -offered by including a <tt>TemplatePreferencePage</tt> which uses a <tt>TemplateStore</tt> and <tt>ContextTypeRegistry</tt> as the -underlying model to store templates. The <tt>org.eclipse.ui.editors.templates</tt> +<code>TemplateProposal</code>s as content assist choices, which is +simplified by using a subclass of <code>TemplateCompletionProcessor</code>. User template management can be +offered by including a <code>TemplatePreferencePage</code> which uses a <code>TemplateStore</code> and <code>ContextTypeRegistry</code> as the +underlying model to store templates. The <code>org.eclipse.ui.editors.templates</code> extension point can be used to allow other plug-ins to contribute -templates to an editor. This is accomplished by using the <tt>ContributionTemplateStore</tt> and <tt>ContributionContextTypeRegistry</tt> +templates to an editor. This is accomplished by using the <code>ContributionTemplateStore</code> and <code>ContributionContextTypeRegistry</code> subclasses of the above types.<br> <br> -Template variables are resolved by a <tt>TemplateVariableResolver.</tt> <tt>GlobalTemplateVariables</tt> offers +Template variables are resolved by a <code>TemplateVariableResolver.</code> <code>GlobalTemplateVariables</code> offers some default variables such as date, user, and selection, but advanced features such as resolving to language constructs can be performed in subclasses.<br> <h4>Classes</h4> <ul> - <li><tt>Template</tt> a template consists of name, context + <li><code>Template</code> a template consists of name, context type identifier, and a pattern.</li> - <li><tt>TemplateTranslator</tt> and <tt>TemplateBuffer</tt> are used to + <li><code>TemplateTranslator</code> and <code>TemplateBuffer</code> are used to parse the template grammar and don't need to be used usually.</li> - <li>A <tt>TemplateProposal </tt>can be -offered in content assist, possibly created by a subclass of <tt>TemplateCompletionProcessor.</tt></li> - <li><tt>TemplateStore</tt> and <tt>ContextTypeRegistry</tt> manage a + <li>A <code>TemplateProposal </code>can be +offered in content assist, possibly created by a subclass of <code>TemplateCompletionProcessor.</code></li> + <li><code>TemplateStore</code> and <code>ContextTypeRegistry</code> manage a set of templates within a plug-in and offer ways to store them in the -preferences or externally in XML streams via a <tt>TemplateReaderWriter</tt>.<br></li> - <li><tt>ContributionTemplateStore</tt> and <tt>ContributionContextTypeRegistry</tt> -add awareness for the <tt>org.eclipse.ui.editors.templates</tt> +preferences or externally in XML streams via a <code>TemplateReaderWriter</code>.<br></li> + <li><code>ContributionTemplateStore</code> and <code>ContributionContextTypeRegistry</code> +add awareness for the <code>org.eclipse.ui.editors.templates</code> extension point.</li> - <li><tt>TemplatePreferencePage</tt> allows -the user to access the templates within a <tt>TemplateStore.</tt></li> + <li><code>TemplatePreferencePage</code> allows +the user to access the templates within a <code>TemplateStore.</code></li> </ul> <h4>Example</h4> See the Template Editor Example in the <strong>org.eclipse.ui.examples.javaeditor</strong> project.<br> |