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
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>
-rw-r--r--org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/package.html8
-rw-r--r--org.eclipse.jface.text/projection/org/eclipse/jface/text/source/projection/package.html4
-rw-r--r--org.eclipse.jface.text/src/org/eclipse/jface/contentassist/package.html10
-rw-r--r--org.eclipse.jface.text/src/org/eclipse/jface/text/contentassist/package.html10
-rw-r--r--org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/package.html38
-rw-r--r--org.eclipse.jface.text/src/org/eclipse/jface/text/hyperlink/package.html16
-rw-r--r--org.eclipse.jface.text/src/org/eclipse/jface/text/information/package.html8
-rw-r--r--org.eclipse.jface.text/src/org/eclipse/jface/text/presentation/package.html12
-rw-r--r--org.eclipse.jface.text/src/org/eclipse/jface/text/quickassist/package.html16
-rw-r--r--org.eclipse.jface.text/src/org/eclipse/jface/text/reconciler/package.html12
-rw-r--r--org.eclipse.jface.text/src/org/eclipse/jface/text/revisions/package.html4
-rw-r--r--org.eclipse.jface.text/src/org/eclipse/jface/text/rules/package.html10
-rw-r--r--org.eclipse.jface.text/src/org/eclipse/jface/text/templates/persistence/package.html38
-rw-r--r--org.eclipse.text/projection/org/eclipse/jface/text/projection/package.html14
-rw-r--r--org.eclipse.text/src/org/eclipse/jface/text/source/package.html18
-rw-r--r--org.eclipse.text/src/org/eclipse/text/undo/package.html6
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/package.html4
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/templates/package.html38
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractDecoratedTextEditorPreferenceConstants.java2
-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
26 files changed, 216 insertions, 200 deletions
diff --git a/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/package.html b/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/package.html
index af6d55041..3da5557f5 100644
--- a/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/package.html
+++ b/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/package.html
@@ -9,9 +9,9 @@
<h2>Package Specification</h2>
<p>File buffers represent a file that is being edited. Text file buffers are
specific for text files. They represent the content of a text file in form of
- an <tt>IDocument</tt> and and associated <tt>IAnnotationModel</tt>. File buffers are managed by
- a file buffer manager. The <tt>org.eclipse.core.filebuffers</tt> plug-in provides a default
- file buffer manager that can be obtained by calling <tt>FileBuffers.getTextFileBufferManager()</tt>.
- The file buffer manager supports listeners, <tt>IFileBufferListener</tt>, that are informed about all relevant
+ an <code>IDocument</code> and and associated <code>IAnnotationModel</code>. File buffers are managed by
+ a file buffer manager. The <code>org.eclipse.core.filebuffers</code> plug-in provides a default
+ file buffer manager that can be obtained by calling <code>FileBuffers.getTextFileBufferManager()</code>.
+ The file buffer manager supports listeners, <code>IFileBufferListener</code>, that are informed about all relevant
state changes of file buffers as well as their creation and disposal.</p>
</body></html> \ No newline at end of file
diff --git a/org.eclipse.jface.text/projection/org/eclipse/jface/text/source/projection/package.html b/org.eclipse.jface.text/projection/org/eclipse/jface/text/source/projection/package.html
index 769ec456f..09c136732 100644
--- a/org.eclipse.jface.text/projection/org/eclipse/jface/text/source/projection/package.html
+++ b/org.eclipse.jface.text/projection/org/eclipse/jface/text/source/projection/package.html
@@ -10,7 +10,7 @@ is a text viewer that allows to expand and collapse folded regions defined by a
annotation model, projection annotations. The projection viewer offers support to show a summary for a folded region.
</p>
<h2>Package Specification</h2>
-<p><tt>ProjectionViewer</tt> is a specialized <tt>SourceViewer</tt> that can display line-based folding based on a <tt>ProjectionDocument</tt>. To
-do this it uses supporting classes like <tt>IProjectionListener</tt>, <tt>IProjectionPosition</tt>, <tt>ProjectionAnnotation</tt> and others.
+<p><code>ProjectionViewer</code> is a specialized <code>SourceViewer</code> that can display line-based folding based on a <code>ProjectionDocument</code>. To
+do this it uses supporting classes like <code>IProjectionListener</code>, <code>IProjectionPosition</code>, <code>ProjectionAnnotation</code> and others.
</p>
</body></html> \ No newline at end of file
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 e7b85641a..99858c7f5 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&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>
-<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 2d94dfb32..b8ed7cfea 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&nbsp; 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>&nbsp;
</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 88e138509..5df109eb8 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 88e52177c..5152a840a 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 2c20da020..f8494244d 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 9574694de..545e0eb90 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 9f43b2946..a4676d23f 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>&nbsp;
</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 8f46d6c70..e893f11c1 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&nbsp; reconciler provides generic synchronization support&nbsp; 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 8b92a0a6f..385859269 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 253c05333..ef98a1b2f 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 b0c1b5559..79efa9586 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>
&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>
diff --git a/org.eclipse.text/projection/org/eclipse/jface/text/projection/package.html b/org.eclipse.text/projection/org/eclipse/jface/text/projection/package.html
index 6af027037..100869665 100644
--- a/org.eclipse.text/projection/org/eclipse/jface/text/projection/package.html
+++ b/org.eclipse.text/projection/org/eclipse/jface/text/projection/package.html
@@ -12,12 +12,12 @@
segments have exactly the same sequence in which they apprear as fragments in
the master document.</p>
<h2>Package Specification</h2>
-<p><tt>ProjectionDocument</tt> is custom
- <tt>IDocument</tt> implementation that
- uses a <tt>ProjectionTextStore. </tt>The
- content of the <tt>ProjectionDocument</tt>
- is defined by the <tt>ProjectionMapping.
- </tt>The<tt> ProjectionDocumentManager</tt>
- manages the life cycle of <tt>ProjectionDocuments</tt>
+<p><code>ProjectionDocument</code> is custom
+ <code>IDocument</code> implementation that
+ uses a <code>ProjectionTextStore. </code>The
+ content of the <code>ProjectionDocument</code>
+ is defined by the <code>ProjectionMapping.
+ </code>The<code> ProjectionDocumentManager</code>
+ manages the life cycle of <code>ProjectionDocuments</code>
and their relation to their master documents.</p>
</body></html> \ No newline at end of file
diff --git a/org.eclipse.text/src/org/eclipse/jface/text/source/package.html b/org.eclipse.text/src/org/eclipse/jface/text/source/package.html
index ef91a5274..5ad15f16c 100644
--- a/org.eclipse.text/src/org/eclipse/jface/text/source/package.html
+++ b/org.eclipse.text/src/org/eclipse/jface/text/source/package.html
@@ -11,11 +11,11 @@ Provides a framework for connecting document regions
with annotations and for displaying those.
<h2>
Package Specification</h2>
-<p><tt>IAnnotationModels</tt> manage <tt>Annotations</tt>.
- When an annotation model is connected to an <tt>IDocument</tt>,
+<p><code>IAnnotationModels</code> manage <code>Annotations</code>.
+ When an annotation model is connected to an <code>IDocument</code>,
any change to the document is reflected in the position of the managed annotations.
- Implementers of <tt>IAnnotationModelListener</tt>
- registered with an <tt>IAnnotationModel</tt>
+ Implementers of <code>IAnnotationModelListener</code>
+ registered with an <code>IAnnotationModel</code>
object get informed about changes of the model in respect to annotations.</p>
@@ -23,12 +23,12 @@ Package Specification</h2>
<!-- Below is the package documentation for org.eclipse.jface.text.source from the org.eclipse.jface.text plug-in -->
<!-- ============================================================================================================ -->
-<p><tt>ISourceViewer</tt> defines the concept of a document based, editable
-viewer supporting visual annotations. <tt>ISourceViewer</tt> supports document-specific
+<p><code>ISourceViewer</code> defines the concept of a document based, editable
+viewer supporting visual annotations. <code>ISourceViewer</code> supports document-specific
and viewer-specific annotations attached to the viewer's input document.
-An <tt>ISourceViewer</tt> uses an <tt>IAnnotationModel</tt> to manage annotations
-and to inform implementers of <tt>IAnnotationModelListener</tt> about changes
-in respect to annotations. An <tt>IVerticalRuler</tt> represents an <tt>IAnnotationModel</tt>
+An <code>ISourceViewer</code> uses an <code>IAnnotationModel</code> to manage annotations
+and to inform implementers of <code>IAnnotationModelListener</code> about changes
+in respect to annotations. An <code>IVerticalRuler</code> represents an <code>IAnnotationModel</code>
access adapter for an SWT widget capapble of display annotations.&nbsp;
This package also provides default implementations for all defined interfaces.
<br></p>
diff --git a/org.eclipse.text/src/org/eclipse/text/undo/package.html b/org.eclipse.text/src/org/eclipse/text/undo/package.html
index b00768982..b56460779 100644
--- a/org.eclipse.text/src/org/eclipse/text/undo/package.html
+++ b/org.eclipse.text/src/org/eclipse/text/undo/package.html
@@ -7,8 +7,8 @@
<body>
<p>Provides undo and redo support for a document.</p>
<h2>Package Specification</h2>
-<p>When an <tt>IDocumentUndoManager</tt> is connected to an <tt>IDocument</tt>,
+<p>When an <code>IDocumentUndoManager</code> is connected to an <code>IDocument</code>,
any change to the document is recorded and can then be undone and redone later.
- Clients which are interested in undo/redo events can register an <tt>IDocumentUndoistener</tt>
- with the <tt>IDocumentUndoManager</tt>.</p>
+ Clients which are interested in undo/redo events can register an <code>IDocumentUndoistener</code>
+ with the <code>IDocumentUndoManager</code>.</p>
</body></html> \ No newline at end of file
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/package.html b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/package.html
index 688aefd2d..9cf2435e1 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/package.html
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/package.html
@@ -6,7 +6,7 @@
</head>
<body>
Provides a standard text editor and concrete document providers based
-<tt>IFileBuffer</tt> and others directly handling <tt>IFile</tt> and
-<tt>IStorage</tt> as editor input.
+<code>IFileBuffer</code> and others directly handling <code>IFile</code> and
+<code>IStorage</code> as editor input.
</body>
</html>
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/templates/package.html b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/templates/package.html
index ba11f5354..b7c46fa2b 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/templates/package.html
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/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>
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractDecoratedTextEditorPreferenceConstants.java b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractDecoratedTextEditorPreferenceConstants.java
index eb7653132..0717f0611 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractDecoratedTextEditorPreferenceConstants.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractDecoratedTextEditorPreferenceConstants.java
@@ -426,6 +426,7 @@ public class AbstractDecoratedTextEditorPreferenceConstants {
*
* <p>
* The following preferences can be used for fine-grained configuration when enabled.
+ * </p>
* <ul>
* <li>{@link #EDITOR_SHOW_LEADING_SPACES}</li>
* <li>{@link #EDITOR_SHOW_ENCLOSED_SPACES}</li>
@@ -440,7 +441,6 @@ public class AbstractDecoratedTextEditorPreferenceConstants {
* <li>{@link #EDITOR_SHOW_LINE_FEED}</li>
* <li>{@link #EDITOR_WHITESPACE_CHARACTER_ALPHA_VALUE}</li>
* </ul>
- * </p>
*
* @since 3.3
*/
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