Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlexander Kurtakov2019-02-18 10:47:40 -0500
committerAlexander Kurtakov2019-02-18 10:47:40 -0500
commita11559061cad795991a3cedf2b5865928b37b77c (patch)
treed2646d95768f2a242b88b24e3351f7a9d8c42061 /org.eclipse.ui.workbench.texteditor
parent5022557f3c9c7735813111b5c2a0d7ff07f8b12e (diff)
downloadeclipse.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.ui.workbench.texteditor')
-rw-r--r--org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/contentassist/package.html4
-rw-r--r--org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ResourceAction.java50
-rw-r--r--org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/link/package.html2
-rw-r--r--org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/package.html16
-rw-r--r--org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/rulers/IContributedRulerColumn.java21
-rw-r--r--org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/AbstractTemplatesPage.java17
-rw-r--r--org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/package.html38
7 files changed, 82 insertions, 66 deletions
diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/contentassist/package.html b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/contentassist/package.html
index b87d7a8d7..9c04cd8d5 100644
--- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/contentassist/package.html
+++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/contentassist/package.html
@@ -7,14 +7,14 @@
<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&nbsp; 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>
-The <tt>ContentAssistHandler</tt> provides API for an easy setup of a <tt>SubjectControlContentAssistant</tt> for a Text or a Combo widget.
+The <code>ContentAssistHandler</code> provides API for an easy setup of a <code>SubjectControlContentAssistant</code> for a Text or a Combo widget.
<br>&nbsp;
</body>
</html>
diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ResourceAction.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ResourceAction.java
index 918c5b035..3f84654a1 100644
--- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ResourceAction.java
+++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ResourceAction.java
@@ -61,21 +61,25 @@ public abstract class ResourceAction extends Action {
* Creates a new action that configures itself from the given resource
* bundle.
* <p>
- * The following keys, prepended by the given option prefix,
- * are used for retrieving resources from the given bundle:
+ * The following keys, prepended by the given option prefix, are used for
+ * retrieving resources from the given bundle:
+ * </p>
* <ul>
- * <li><code>"label"</code> - <code>setText</code></li>
- * <li><code>"tooltip"</code> - <code>setToolTipText</code></li>
- * <li><code>"image"</code> - <code>setImageDescriptor</code></li>
- * <li><code>"description"</code> - <code>setDescription</code></li>
+ * <li><code>"label"</code> - <code>setText</code></li>
+ * <li><code>"tooltip"</code> - <code>setToolTipText</code></li>
+ * <li><code>"image"</code> - <code>setImageDescriptor</code></li>
+ * <li><code>"description"</code> - <code>setDescription</code></li>
* </ul>
- * </p>
*
- * @param bundle the resource bundle
- * @param prefix a prefix to be prepended to the various resource keys, or
- * <code>null</code> if none
- * @param style one of <code>IAction.AS_PUSH_BUTTON</code>, <code>IAction.AS_CHECK_BOX</code>,
- * and <code>IAction.AS_RADIO_BUTTON</code>.
+ * @param bundle
+ * the resource bundle
+ * @param prefix
+ * a prefix to be prepended to the various resource keys, or
+ * <code>null</code> if none
+ * @param style
+ * one of <code>IAction.AS_PUSH_BUTTON</code>,
+ * <code>IAction.AS_CHECK_BOX</code>, and
+ * <code>IAction.AS_RADIO_BUTTON</code>.
*
* @see ResourceAction#ResourceAction(ResourceBundle, String)
* @see org.eclipse.jface.action.IAction#AS_CHECK_BOX
@@ -93,19 +97,21 @@ public abstract class ResourceAction extends Action {
* Creates a new action that configures itself from the given resource
* bundle.
* <p>
- * The following keys, prepended by the given option prefix,
- * are used for retrieving resources from the given bundle:
+ * The following keys, prepended by the given option prefix, are used for
+ * retrieving resources from the given bundle:
+ * </p>
* <ul>
- * <li><code>"label"</code> - <code>setText</code></li>
- * <li><code>"tooltip"</code> - <code>setToolTipText</code></li>
- * <li><code>"image"</code> - <code>setImageDescriptor</code></li>
- * <li><code>"description"</code> - <code>setDescription</code></li>
+ * <li><code>"label"</code> - <code>setText</code></li>
+ * <li><code>"tooltip"</code> - <code>setToolTipText</code></li>
+ * <li><code>"image"</code> - <code>setImageDescriptor</code></li>
+ * <li><code>"description"</code> - <code>setDescription</code></li>
* </ul>
- * </p>
*
- * @param bundle the resource bundle
- * @param prefix a prefix to be prepended to the various resource keys, or
- * <code>null</code> if none
+ * @param bundle
+ * the resource bundle
+ * @param prefix
+ * a prefix to be prepended to the various resource keys, or
+ * <code>null</code> if none
*/
public ResourceAction(ResourceBundle bundle, String prefix) {
super();
diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/link/package.html b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/link/package.html
index 1b19c3f00..5a0c01f7a 100644
--- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/link/package.html
+++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/link/package.html
@@ -7,5 +7,5 @@
</head>
<body>
-Adds a <tt>LinkedModeUI</tt> subclass that is aware of workbench editors.
+Adds a <code>LinkedModeUI</code> subclass that is aware of workbench editors.
</body></html> \ No newline at end of file
diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/package.html b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/package.html
index 0ebf7f2db..a72e69f23 100644
--- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/package.html
+++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/package.html
@@ -11,20 +11,20 @@ Provides a framework for text editors obeying to the
desktop rules.
<h2>
Package Specification</h2>
-<tt>ITextEditor</tt> extends <tt>IEditorPart</tt> with text editor specific
-functionality. Text editors use source viewers (<tt>ISourceViewer</tt>)
+<code>ITextEditor</code> extends <code>IEditorPart</code> with text editor specific
+functionality. Text editors use source viewers (<code>ISourceViewer</code>)
for displaying and editing the given editor input. In order to translate
the editor input into a document and vice versa (e.g., for saving a change),
-a text editor uses document providers (<tt>IDocumentProvider</tt>). A document
+a text editor uses document providers (<code>IDocumentProvider</code>). A document
provider is responsible not just for providing the document for a given
editor input but for the complete translation between the domain model
and the editor's internal document-based model. Document provider can be
shared between editors.
-<br>The package provides a default implementation of <tt>ITextEditor</tt>
-(<tt>AbstractTextEditor</tt>). This default implementation also covers
+<br>The package provides a default implementation of <code>ITextEditor</code>
+(<code>AbstractTextEditor</code>). This default implementation also covers
the editor's complete action management and activation. The package contains
-a number of configurable and predefined actions. <tt>AbstractMarkerAnnotationModel</tt>
-establishs a link between text annotations (<tt>Annotation</tt>) and desktop
-markers (<tt>IMarker</tt>).
+a number of configurable and predefined actions. <code>AbstractMarkerAnnotationModel</code>
+establishs a link between text annotations (<code>Annotation</code>) and desktop
+markers (<code>IMarker</code>).
</body>
</html>
diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/rulers/IContributedRulerColumn.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/rulers/IContributedRulerColumn.java
index 0d99744eb..6013600f9 100644
--- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/rulers/IContributedRulerColumn.java
+++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/rulers/IContributedRulerColumn.java
@@ -68,30 +68,35 @@ public interface IContributedRulerColumn extends IVerticalRulerColumn {
/**
* Hook method called after a column has been instantiated, but before it is
- * added to a {@link org.eclipse.jface.text.source.CompositeRuler} and before
- * {@linkplain org.eclipse.jface.text.source.IVerticalRulerColumn#createControl(org.eclipse.jface.text.source.CompositeRuler, org.eclipse.swt.widgets.Composite) createControl}
- * is called.
+ * added to a {@link org.eclipse.jface.text.source.CompositeRuler} and
+ * before
+ * {@linkplain org.eclipse.jface.text.source.IVerticalRulerColumn#createControl(org.eclipse.jface.text.source.CompositeRuler, org.eclipse.swt.widgets.Composite)
+ * createControl} is called.
* <p>
* This happens when
+ * </p>
* <ul>
* <li>the column is set visible by the user or programmatically</li>
- * <li>the editor is created, if this ruler targets the editor and is enabled by default</li>
- * <li>the editor input changes and the column now targets the new editor contents.</li>
- * </ul></p>
+ * <li>the editor is created, if this ruler targets the editor and is
+ * enabled by default</li>
+ * <li>the editor input changes and the column now targets the new editor
+ * contents.</li>
+ * </ul>
*/
void columnCreated();
/**
- * Hook method called after a column has been removed from the {@link org.eclipse.jface.text.source.CompositeRuler}.
+ * Hook method called after a column has been removed from the
+ * {@link org.eclipse.jface.text.source.CompositeRuler}.
* <p>
* This happens when
+ * </p>
* <ul>
* <li>the column is hidden by the user or programmatically</li>
* <li>the editor is closed</li>
* <li>the editor input changes and the column no longer targets the editor
* contents.</li>
* </ul>
- * </p>
* <p>
* The column will not be used after this method has been called. A new
* column will be instantiated if the same column type should be shown for
diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/AbstractTemplatesPage.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/AbstractTemplatesPage.java
index 25f34361f..12bdb29f5 100644
--- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/AbstractTemplatesPage.java
+++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/AbstractTemplatesPage.java
@@ -552,13 +552,18 @@ public abstract class AbstractTemplatesPage extends Page implements ITemplatesPa
/**
* Creates and opens a dialog to edit the given template.
- * <p
- * Subclasses may override this method to provide a custom dialog.</p>
+ * <p>
+ * Subclasses may override this method to provide a custom dialog.
+ * </p>
*
- * @param template the template being edited
- * @param edit <code>true</code> if the dialog allows editing
- * @param isNameModifiable <code>true</code> if the template name may be modified
- * @return the created or modified template, or <code>null</code> if the editing failed
+ * @param template
+ * the template being edited
+ * @param edit
+ * <code>true</code> if the dialog allows editing
+ * @param isNameModifiable
+ * <code>true</code> if the template name may be modified
+ * @return the created or modified template, or <code>null</code> if the
+ * editing failed
*/
protected Template editTemplate(Template template, boolean edit, boolean isNameModifiable) {
EditTemplateDialog dialog= new EditTemplateDialog(getShell(), template, edit, isNameModifiable, getContextTypeRegistry());
diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/package.html b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/package.html
index ba11f5354..b7c46fa2b 100644
--- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/package.html
+++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/templates/package.html
@@ -25,7 +25,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>
@@ -34,40 +34,40 @@ an instance check in Java:<br>
&nbsp;&nbsp;&nbsp; ${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>

Back to the top