diff options
author | Alexander Kurtakov | 2019-02-18 15:47:40 +0000 |
---|---|---|
committer | Alexander Kurtakov | 2019-02-18 15:47:40 +0000 |
commit | a11559061cad795991a3cedf2b5865928b37b77c (patch) | |
tree | d2646d95768f2a242b88b24e3351f7a9d8c42061 /org.eclipse.jface.text/src/org | |
parent | 5022557f3c9c7735813111b5c2a0d7ff07f8b12e (diff) | |
download | eclipse.platform.text-a11559061cad795991a3cedf2b5865928b37b77c.tar.gz eclipse.platform.text-a11559061cad795991a3cedf2b5865928b37b77c.tar.xz eclipse.platform.text-a11559061cad795991a3cedf2b5865928b37b77c.zip |
Bug 543933 - Build javadocs with Java 11
Fix javadoc warnings catched by Java 11 tool with XDoclint:html.
Change-Id: I361b79bda124f98380dec2c87ca41b09f4098643
Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>
Diffstat (limited to 'org.eclipse.jface.text/src/org')
11 files changed, 87 insertions, 87 deletions
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/contentassist/package.html b/org.eclipse.jface.text/src/org/eclipse/jface/contentassist/package.html index e7b85641a7c..99858c7f5b6 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/contentassist/package.html +++ b/org.eclipse.jface.text/src/org/eclipse/jface/contentassist/package.html @@ -7,18 +7,18 @@ <title>Package-level Javadoc</title> </head> <body> -Provides a content assist add-on for implementors of <tt>IContentAssistSubjectControl</tt>. +Provides a content assist add-on for implementors of <code>IContentAssistSubjectControl</code>. Content assist supports the user in writing by proposing context sensitive completions at a given position. A completion can also be a incomplete in itself and content assist provides means to deal with nested completions. <h2> Package Specification</h2> -<tt>ISubjectControlContentAssistant</tt> defines the concept of the content assist add-on. -It collaborates with content type specific completion processors (<tt>ISubjectControlContentAssistProcessor</tt>) -in order to generate completion proposals (<tt>ICompletionProposal</tt>) +<code>ISubjectControlContentAssistant</code> defines the concept of the content assist add-on. +It collaborates with content type specific completion processors (<code>ISubjectControlContentAssistProcessor</code>) +in order to generate completion proposals (<code>ICompletionProposal</code>) valid at the current document position. The package provides a default -implementation <tt>SubjectControlContentAssistant</tt> which completely defines and implements +implementation <code>SubjectControlContentAssistant</code> which completely defines and implements the UI and the control flow for content assist. <br> <br> diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/package.html b/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/package.html index 2d94dfb3203..b8ed7cfead9 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/package.html +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/package.html @@ -7,18 +7,18 @@ <title>Package-level Javadoc</title> </head> <body> -Provides a content assist add-on for an <tt>ITextViewer</tt>. +Provides a content assist add-on for an <code>ITextViewer</code>. Content assist supports the user in writing by proposing context sensitive completions at a given document position. A completion can also be a incomplete in itself and content assist provides means to deal with nested completions. <h2> Package Specification</h2> -<tt>IContentAssistant</tt> defines the concept of the content assist add-on. -It collaborates with content type specific completion processors (<tt>IContentAssistProcessor</tt>) -in order to generate completion proposals (<tt>ICompletionProposal</tt>) +<code>IContentAssistant</code> defines the concept of the content assist add-on. +It collaborates with content type specific completion processors (<code>IContentAssistProcessor</code>) +in order to generate completion proposals (<code>ICompletionProposal</code>) valid at the current document position. The package provides a default -implementation <tt>ContentAssistant</tt> which completely defines and implements +implementation <code>ContentAssistant</code> which completely defines and implements the UI and the control flow for content assist. <br> </body> diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/package.html b/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/package.html index 88e13850944..5df109eb838 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/package.html +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/package.html @@ -7,24 +7,24 @@ <title>Package-level Javadoc</title> </head> <body> -Provides a content formatter add-on for an <tt>ITextViewer</tt>. +Provides a content formatter add-on for an <code>ITextViewer</code>. A content formatter changes the formatting of a document region while preserving and correctly updating the positions of the document. <h2>Package Specification</h2> -<tt>IContentFormatter</tt> defines the concept of a text formatter. It -collaborates with content type specific formatting stratgies (<tt>IFormattingStrategy</tt>) +<code>IContentFormatter</code> defines the concept of a text formatter. It +collaborates with content type specific formatting stratgies (<code>IFormattingStrategy</code>) which for a given document region format the subregion with the matching -content type. The package contains a default implementation of <tt>IContentFormatter</tt> -(<tt>ContentFormatter</tt>).<br> -Additionally, an implementation of <tt>IContentFormatterExtension</tt> +content type. The package contains a default implementation of <code>IContentFormatter</code> +(<code>ContentFormatter</code>).<br> +Additionally, an implementation of <code>IContentFormatterExtension</code> is provided for text edit based formatting strategies. This implementation only accepts formatting strategies -implementing the extension interface <tt>IFormattingStrategyExtension</tt>. +implementing the extension interface <code>IFormattingStrategyExtension</code>. These formatting strategies are required to handle the position updating of the document. To facilitate the work with these text edit -based formatting strategies, a default implementation called <tt>ContextBasedFormattingStrategy</tt> +based formatting strategies, a default implementation called <code>ContextBasedFormattingStrategy</code> is provided. Formatting strategies inheriting from this class are text edit based and behave context dependent. Depending on the formatting context that is passed @@ -34,17 +34,17 @@ to format different parts of a document. following steps are needed: </p> <ul> - <li>Create an instance of <tt>IFormattingContext</tt>. The default -implementation <tt>FormattingContext</tt> already + <li>Create an instance of <code>IFormattingContext</code>. The default +implementation <code>FormattingContext</code> already provides support for the conversion of preferences from a preference -store to a map and vice versa. The method <tt>getPreferenceKeys</tt> +store to a map and vice versa. The method <code>getPreferenceKeys</code> usually has to be overridden to return the appropriate keys of the preferences used during the formatting process. Then register a map of preferences -with the formatting context by calling <tt>setProperty(String, Object)</tt> -with the property identifier <tt>FormattingContextProperties.CONTEXT_PREFERENCES</tt>.</li> +with the formatting context by calling <code>setProperty(String, Object)</code> +with the property identifier <code>FormattingContextProperties.CONTEXT_PREFERENCES</code>.</li> <li>Create an instance of the text edit based content formatter class - <tt>MultiPassContentFormatter</tt>. The document partitioning and + <code>MultiPassContentFormatter</code>. The document partitioning and its associated default content type have to be passed to the constructor. This information is needed since the content formatter is able to format @@ -61,8 +61,8 @@ strategy for a content type other than the default content type.</li> <li>Specify the proper formatting mode (see FormattingContextProperties): <ul> - <li>For whole document formatting set the property <tt>CONTEXT_DOCUMENT</tt> -of the created formatting context to <tt>true</tt>. This is + <li>For whole document formatting set the property <code>CONTEXT_DOCUMENT</code> +of the created formatting context to <code>true</code>. This is equivalent to setting <code>CONTEXT_REGION</code> with a region spanning the whole document.</li> <li>For multiple region formatting set the property <code>CONTEXT_REGION</code> @@ -73,15 +73,15 @@ covered only partially by the region for the slave formatting strategies.</li> <li>For explicit formatting of a partition with the formatting strategy registered for a certain content type use the -property <tt>CONTEXT_PARTITION</tt>. Note that the region denoted by +property <code>CONTEXT_PARTITION</code>. Note that the region denoted by this property must correspond to a partition relative to the specified partitioning in the document to be formatted. The content type of this property overrides the content type of the partition in the document.</li> </ul> </li> - <li>Call the method <tt>MultiPassContentFormatter#format(IDocument, -IFormattingContext)</tt> with the created formatting context + <li>Call the method <code>MultiPassContentFormatter#format(IDocument, +IFormattingContext)</code> with the created formatting context and the document to be formatted.</li> </ul> </body> diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/package.html b/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/package.html index 88e52177c8e..5152a840ae9 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/package.html +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/package.html @@ -7,19 +7,19 @@ <title>Package-level Javadoc</title> </head> <body> -Provides support for detecting and displaying hyperlinks in <tt>ISourceViewer</tt>s. +Provides support for detecting and displaying hyperlinks in <code>ISourceViewer</code>s. <p> -<tt>SourceViewer</tt> supports hyperlinked text regions inline in the displayed text. It delegates -the detection and presentation of hyperlinks to <tt>IHyperlinkDetector</tt> and <tt>IHyperlinkPresenter</tt>, respectively. +<code>SourceViewer</code> supports hyperlinked text regions inline in the displayed text. It delegates +the detection and presentation of hyperlinks to <code>IHyperlinkDetector</code> and <code>IHyperlinkPresenter</code>, respectively. </p> <p> -Override the following methods in <tt>SourceViewerConfiguration</tt> to customize the hyperlink behavior of a source viewer: +Override the following methods in <code>SourceViewerConfiguration</code> to customize the hyperlink behavior of a source viewer: +</p> <ul> - <li><tt>getHyperlinkDetectors()</tt> to specify the set of hyperlink detectors used by the viewer</li> - <li><tt>getHyperlinkPresenter()</tt> to specify the set of hyperlink presenters used by the viewer</li> - <li><tt>getHyperlinkStateMask()</tt> to specify when hyperlinks are activated</li> + <li><code>getHyperlinkDetectors()</code> to specify the set of hyperlink detectors used by the viewer</li> + <li><code>getHyperlinkPresenter()</code> to specify the set of hyperlink presenters used by the viewer</li> + <li><code>getHyperlinkStateMask()</code> to specify when hyperlinks are activated</li> </ul> -</p> </body> </html> diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/information/package.html b/org.eclipse.jface.text/src/org/eclipse/jface/text/information/package.html index 2c20da02084..f8494244dda 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/information/package.html +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/information/package.html @@ -7,16 +7,16 @@ <title>Package-level Javadoc</title> </head> <body> -Provides an information provider add-on for an <tt>ITextViewer</tt>. +Provides an information provider add-on for an <code>ITextViewer</code>. An information provider presents information for a certain subject in a specific information control. An information control usually is a floating window. <h2> Package Specification</h2> -<tt>IInformationPresenter</tt> defines the concept of an information provider. -It collaborates with content type specific information providers (<tt>IInformationProvider</tt>) +<code>IInformationPresenter</code> defines the concept of an information provider. +It collaborates with content type specific information providers (<code>IInformationProvider</code>) which determine for a certain offset in a text viewer an information subject and the information available about this subject.. The package contains -a default implementation of <tt>IInformationPresenter</tt> (<tt>InformationPresenter</tt>). +a default implementation of <code>IInformationPresenter</code> (<code>InformationPresenter</code>). </body> </html> diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/presentation/package.html b/org.eclipse.jface.text/src/org/eclipse/jface/text/presentation/package.html index 9574694de4e..545e0eb9000 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/presentation/package.html +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/presentation/package.html @@ -7,18 +7,18 @@ <title>Package-level Javadoc</title> </head> <body> -Provides a presentation reconciler add-on for an <tt>ITextViewer</tt>. +Provides a presentation reconciler add-on for an <code>ITextViewer</code>. A presentation reconciler keep the presentation (styles and colors) in -sync with the content of the document serving as the <tt>ITextViewer</tt>'s +sync with the content of the document serving as the <code>ITextViewer</code>'s input. <h2> Package Specification</h2> -<tt>IPresentationReconciler</tt> defines the concept of a presentation +<code>IPresentationReconciler</code> defines the concept of a presentation reconciler. It collaborates with content type specific presentation damagers -(<tt>IPresentationDamager</tt>) which for a given document change determine +(<code>IPresentationDamager</code>) which for a given document change determine the region of the presentation which must be rebuild, and content type -specific presentation repairers (<tt>IPresentationRepairer</tt>) which +specific presentation repairers (<code>IPresentationRepairer</code>) which construct for a given damage region the document presentation. The package -contains a default implementation of <tt>IPresentationReconciler </tt>(<tt>PresentationReconciler</tt>). +contains a default implementation of <code>IPresentationReconciler </code>(<code>PresentationReconciler</code>). </body> </html> diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/quickassist/package.html b/org.eclipse.jface.text/src/org/eclipse/jface/text/quickassist/package.html index 9f43b294616..a4676d23f85 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/quickassist/package.html +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/quickassist/package.html @@ -7,23 +7,23 @@ <title>Package-level Javadoc</title> </head> <body> -This package provides the quick assist assistant add-on for an <tt>ISourceViewer</tt>. +This package provides the quick assist assistant add-on for an <code>ISourceViewer</code>. The quick assist assistant's purpose is to propose, display, and insert quick assists and quick fixes available at the current source viewer's quick assist invocation context. <p> -A quick fix is a completion that can correct a problem reported and visible through an <tt>Annotation</tt> -while a quick assist is not related to a problem or <tt>Annotation</tt>. Since quick assists can be proposed +A quick fix is a completion that can correct a problem reported and visible through an <code>Annotation</code> +while a quick assist is not related to a problem or <code>Annotation</code>. Since quick assists can be proposed where appropriate they are normally not visible in the viewer. The quick assist assistant implementation in this package can show the quick assists that are available on the current line. </p> <h2> Package Specification</h2> -<tt>IQuickAssistAssistant</tt> defines the concept of the quick assist assistant add-on. -It collaborates with a quick assist processor (<tt>IQuickAssistProcessor</tt>) -in order to generate quick fix and quick assist completion proposals (<tt>ICompletionProposal</tt>) -available at the current quick assist invocation context (<tt>IQuickAssistInvocationContext</tt>). -The package provides a default implementation <tt>QuickAssistAssistant</tt> which completely defines +<code>IQuickAssistAssistant</code> defines the concept of the quick assist assistant add-on. +It collaborates with a quick assist processor (<code>IQuickAssistProcessor</code>) +in order to generate quick fix and quick assist completion proposals (<code>ICompletionProposal</code>) +available at the current quick assist invocation context (<code>IQuickAssistInvocationContext</code>). +The package provides a default implementation <code>QuickAssistAssistant</code> which completely defines and implements the UI and the control flow for a quick assist assistant. <br> </body> diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/reconciler/package.html b/org.eclipse.jface.text/src/org/eclipse/jface/text/reconciler/package.html index 8f46d6c7019..e893f11c14e 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/reconciler/package.html +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/reconciler/package.html @@ -7,18 +7,18 @@ <title>Package-level Javadoc</title> </head> <body> -Provides a reconciler add-on for an <tt>ITextViewer</tt>. +Provides a reconciler add-on for an <code>ITextViewer</code>. A reconciler provides generic synchronization support with -the content of the document serving as the <tt>ITextViewer</tt>'s input. +the content of the document serving as the <code>ITextViewer</code>'s input. There is no explicit model of what is synchronized. <h2> Package Specification</h2> -<tt>IReconciler</tt> defines the concept of a reconciler. It collaborates -with content type specific reconciling strategies (<tt>IReconcilingStrategy</tt>) +<code>IReconciler</code> defines the concept of a reconciler. It collaborates +with content type specific reconciling strategies (<code>IReconcilingStrategy</code>) which perform the synchronization for a given dirty region. The package -contains a default implementation of <tt>IReconciler</tt> (<tt>Reconciler</tt>). +contains a default implementation of <code>IReconciler</code> (<code>Reconciler</code>). -<tt>Reconciler</tt> and <tt>MonoReconciler</tt> implements reconciling +<code>Reconciler</code> and <code>MonoReconciler</code> implements reconciling as a periodic background activity and folds co-located changes while being inactive. </body> diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/revisions/package.html b/org.eclipse.jface.text/src/org/eclipse/jface/text/revisions/package.html index 8b92a0a6f0d..38585926986 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/revisions/package.html +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/revisions/package.html @@ -8,7 +8,7 @@ <body> Provides a revision model and a protocol to display revision information in a vertical ruler column. <h2>Package Specification</h2> -<tt>IRevisionRulerColumn</tt> is the protocol that a team provider can use to display line based revision control information to a document. -<tt>RevisionInformation</tt> defines the revision model, which contains a list of <tt>Revision</tt>s, which in turn contain <tt>RevisionRange</tt>s. +<code>IRevisionRulerColumn</code> is the protocol that a team provider can use to display line based revision control information to a document. +<code>RevisionInformation</code> defines the revision model, which contains a list of <code>Revision</code>s, which in turn contain <code>RevisionRange</code>s. </body> </html> diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/rules/package.html b/org.eclipse.jface.text/src/org/eclipse/jface/text/rules/package.html index 253c05333b5..ef98a1b2fca 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/rules/package.html +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/rules/package.html @@ -9,13 +9,13 @@ <body> Provides a framework for rule based text scanning and uses the framework to provide rule-driven default implementations of -<tt>IPresentationDamager</tt>, <tt>IPresentationRepairer</tt> and <tt>IDocumentPartitioner</tt>. +<code>IPresentationDamager</code>, <code>IPresentationRepairer</code> and <code>IDocumentPartitioner</code>. <h2> Package Specification</h2> -<tt>RuleBasedScanner</tt> is a document-based scanner controlled by <tt>IRule</tt> -objects. When evaluated an <tt>IRule</tt> always returns an <tt>IToken</tt>. -The package provides a set of rules whereby <tt>PatternRule</tt> is the -most important one. <tt>PatternRule</tt> defines a pattern-configurable +<code>RuleBasedScanner</code> is a document-based scanner controlled by <code>IRule</code> +objects. When evaluated an <code>IRule</code> always returns an <code>IToken</code>. +The package provides a set of rules whereby <code>PatternRule</code> is the +most important one. <code>PatternRule</code> defines a pattern-configurable rule. </body> </html> diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/templates/persistence/package.html b/org.eclipse.jface.text/src/org/eclipse/jface/text/templates/persistence/package.html index b0c1b55593a..79efa958651 100644 --- a/org.eclipse.jface.text/src/org/eclipse/jface/text/templates/persistence/package.html +++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/templates/persistence/package.html @@ -23,7 +23,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> @@ -32,40 +32,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> |