Javadoc polish

25 files changed, 60 insertions, 43 deletions

diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/CursorLinePainter.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/CursorLinePainter.java
index 9caa50dba3a..b99ef779337 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/CursorLinePainter.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/CursorLinePainter.java
@@ -28,9 +28,9 @@ import org.eclipse.jface.text.Position;
 /**
  * A painter the draws the background of the caret line in a configured color.
  * <p>
- * Clients usually instantiate and configure object of this class.
+ * Clients usually instantiate and configure object of this class.</p>
  * <p>
- * This class is not intended to be subclassed.
+ * This class is not intended to be subclassed.</p>
  *
  * @since 2.1
  */
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/DefaultIndentLineAutoEditStrategy.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/DefaultIndentLineAutoEditStrategy.java
index 3997cb02eb3..d56d25f966a 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/DefaultIndentLineAutoEditStrategy.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/DefaultIndentLineAutoEditStrategy.java
@@ -12,8 +12,9 @@ package org.eclipse.jface.text;
 
 
 /**
- * This strategy always copies the indentation of the previous line. This class
- * is not intended to be subclassed.
+ * This strategy always copies the indentation of the previous line.
+ * <p>
+ * This class is not intended to be subclassed.</p>
  *
  * @since 3.1
  */
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/DefaultTextDoubleClickStrategy.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/DefaultTextDoubleClickStrategy.java
index 7d3a5a52e4f..f833e9d7014 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/DefaultTextDoubleClickStrategy.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/DefaultTextDoubleClickStrategy.java
@@ -20,9 +20,10 @@ import java.text.CharacterIterator;
  * {@link org.eclipse.jface.text.ITextDoubleClickStrategy}.
  * <p>
  * Selects words using <code>java.text.BreakIterator</code> for the default
- * locale.
+ * locale.</p>
  * <p>
  * This class is not intended to be subclassed.
+ * </p>
  *
  * @see java.text.BreakIterator
  */
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/DocumentCommand.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/DocumentCommand.java
index 2b0fe032b8b..53b2a06dba5 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/DocumentCommand.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/DocumentCommand.java
@@ -29,7 +29,7 @@ import org.eclipse.swt.events.VerifyEvent;
  * document command can also be used to initialize a given
  * <code>VerifyEvent</code>.
  * <p>
- * A document command can also represent a list of related changes.
+ * A document command can also represent a list of related changes.</p>
  */
 public class DocumentCommand {
 
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/IEditingSupportRegistry.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/IEditingSupportRegistry.java
index a3e706646bb..63b894ff88d 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/IEditingSupportRegistry.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/IEditingSupportRegistry.java
@@ -13,9 +13,9 @@ package org.eclipse.jface.text;
 /**
  * A registry for <code>IEditingSupport</code>s.
  * <p>
- * This interface is not meant to be implemented outside the jface text
- * framework.
- * </p>
+ * This interface is not meant to be implemented outside the JFace text
+ * framework.</p>
+ * 
  * @see IEditingSupport
  * @since 3.1
  */
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/IEventConsumer.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/IEventConsumer.java
index b21c04e1bdc..e7308dd3b67 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/IEventConsumer.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/IEventConsumer.java
@@ -19,12 +19,13 @@ import org.eclipse.swt.events.VerifyEvent;
  * <code>VerifyEvent</code>s before the text viewer they are registered with.
  * If the event consumer marks events as processed by turning their
  * <code>doit</code> field to <code>false</code> the text viewer
- * subsequently ignores them. Clients may implement this interface.
+ * subsequently ignores them.</p>
+ * <p>
+ * Clients may implement this interface.</p>
  * <p>
- *
  * {@link org.eclipse.jface.text.ITextViewerExtension2}allows clients to manage
  * the {@link org.eclipse.swt.events.VerifyListener}s of a text viewer. This
- * makes <code>IEventConsumer</code> obsolete.
+ * makes <code>IEventConsumer</code> obsolete.</p>
  *
  * @see org.eclipse.jface.text.ITextViewer
  * @see org.eclipse.jface.text.ITextViewerExtension2
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/IMarkSelection.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/IMarkSelection.java
index b0797a04819..4c80ff71918 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/IMarkSelection.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/IMarkSelection.java
@@ -22,6 +22,7 @@ import org.eclipse.jface.viewers.ISelection;
  * <p>
  * This interface is not intended to be implemented by clients others than
  * {@link org.eclipse.jface.text.ITextViewer} implementers.
+ * </p>
  *
  * @since 2.0
  */
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/IPainter.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/IPainter.java
index e0262e7a2c6..5651c387ff1 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/IPainter.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/IPainter.java
@@ -16,8 +16,9 @@ package org.eclipse.jface.text;
  * A painter is responsible for creating, managing, updating, and removing
  * visual decorations on an <code>ITextViewer</code>'s text widget. Examples
  * are the highlighting of the caret line, the print margin, or the highlighting
- * of matching peer characters such as pairs of brackets. Clients may implement
- * this interface.
+ * of matching peer characters such as pairs of brackets.</p>
+ * <p>
+ * Clients may implement this interface.</p>
  * <p>
  * Painters should be registered with a
  * {@link org.eclipse.jface.text.PaintManager}. The paint manager tracks
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/IContentFormatter.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/IContentFormatter.java
index 465978ace46..aa8bd2cf580 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/IContentFormatter.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/IContentFormatter.java
@@ -26,9 +26,10 @@ import org.eclipse.jface.text.IRegion;
  * activated in the sequence defined by the partitioning of the document range to be
  * formatted. It is assumed that a strategy must be finished before the next strategy
  * can be activated. After the last strategy has been finished, all strategies are
- * informed about the termination of the formatting process.<p>
+ * informed about the termination of the formatting process.</p>
+ * <p>
  * The interface can be implemented by clients. By default, clients use <code>ContentFormatter</code>
- * or <code>MultiPassContentFormatter</code> as the standard implementers of this interface.
+ * or <code>MultiPassContentFormatter</code> as the standard implementers of this interface.</p>
  *
  * @see IDocument
  * @see IFormattingStrategy
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/IFormattingStrategy.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/IFormattingStrategy.java
index 6e39572a995..1416890aa55 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/IFormattingStrategy.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/IFormattingStrategy.java
@@ -21,8 +21,9 @@ package org.eclipse.jface.text.formatter;
  * <li><code>format</code>
  * <li><code>formatterStops</code>
  * </ul>
+ * <p>
  * This interface must be implemented by clients. Implementers should be registered with
- * a content formatter in order get involved in the formatting process.
+ * a content formatter in order get involved in the formatting process.</p>
  */
 public interface IFormattingStrategy {
 
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/presentation/IPresentationDamager.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/presentation/IPresentationDamager.java
index 6030e34be80..b3607e85622 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/presentation/IPresentationDamager.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/presentation/IPresentationDamager.java
@@ -31,7 +31,7 @@ import org.eclipse.jface.text.ITypedRegion;
  * rule-based default implementation
  * {@link org.eclipse.jface.text.rules.DefaultDamagerRepairer}. Implementers
  * should be registered with a presentation reconciler in order get involved in
- * the reconciling process.
+ * the reconciling process.</p>
  *
  * @see IPresentationReconciler
  * @see IDocument
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/AnnotationPainter.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/AnnotationPainter.java
index f5acd521bbd..e2585e96ba3 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/AnnotationPainter.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/AnnotationPainter.java
@@ -49,10 +49,9 @@ import org.eclipse.jface.text.TextPresentation;
  * <p>
  * The annotation painter can be configured with drawing strategies. A drawing
  * strategy defines the visual presentation of a particular type of annotation
- * decoration.
+ * decoration.</p>
  * <p>
- *
- * Clients usually instantiate and configure objects of this class.
+ * Clients usually instantiate and configure objects of this class.</p>
  *
  * @since 2.1
  */
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/AnnotationRulerColumn.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/AnnotationRulerColumn.java
index 75cead41e80..680510d7f81 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/AnnotationRulerColumn.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/AnnotationRulerColumn.java
@@ -55,7 +55,10 @@ import org.eclipse.jface.text.TextViewer;
 
 /**
  * A vertical ruler column showing graphical representations of annotations.
- * Will become final. Do not subclass.
+ * Will become final.
+ * <p>
+ * Do not subclass.
+ * </p>
  *
  * @since 2.0
  */
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/CompositeRuler.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/CompositeRuler.java
index a64e9686a9a..58a0b778642 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/CompositeRuler.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/CompositeRuler.java
@@ -59,9 +59,9 @@ import org.eclipse.jface.text.ITextViewerExtension5;
  * This ruler does not have a a visual representation of its own. The
  * presentation comes from the configurable list of vertical ruler columns. Such
  * columns must implement the
- * {@link org.eclipse.jface.text.source.IVerticalRulerColumn}. interface.
+ * {@link org.eclipse.jface.text.source.IVerticalRulerColumn}. interface.</p>
  * <p>
- * Clients may instantiate and configure this class.
+ * Clients may instantiate and configure this class.</p>
  *
  * @see org.eclipse.jface.text.source.IVerticalRulerColumn
  * @see org.eclipse.jface.text.ITextViewer
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IAnnotationAccess.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IAnnotationAccess.java
index 4489490813a..a35cc620f2c 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IAnnotationAccess.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IAnnotationAccess.java
@@ -22,9 +22,9 @@ package org.eclipse.jface.text.source;
  * <ul>
  * <li>{@link org.eclipse.jface.text.source.IAnnotationAccessExtension}since
  *     version 3.0 replacing all methods in that interface</li>
- * </ul>
+ * </ul></p>
  * <p>
- * Clients usually implement this interface and its extension interfaces.
+ * Clients usually implement this interface and its extension interfaces.</p>
  *
  * @see org.eclipse.jface.text.source.IAnnotationAccessExtension
  * @see org.eclipse.jface.text.source.Annotation
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IAnnotationHover.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IAnnotationHover.java
index 39b5d3574ef..5def8387e76 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IAnnotationHover.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IAnnotationHover.java
@@ -24,9 +24,9 @@ package org.eclipse.jface.text.source;
  *     version 3.0 allowing a text hover to provide a creator for the hover control.
  *     This allows for sophisticated hovers in a way that information computed by
  *     the hover can be displayed in the best possible form.</li>
- * </ul>
+ * </ul></p>
  * <p>
- * Clients may implement this interface.
+ * Clients may implement this interface.</p>
  *
  * @see org.eclipse.jface.text.source.IAnnotationHoverExtension
  */
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IOverviewRuler.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IOverviewRuler.java
index 0c04d2c60a1..6b373894c8d 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IOverviewRuler.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IOverviewRuler.java
@@ -19,7 +19,7 @@ import org.eclipse.swt.widgets.Control;
  * presentation of annotations is independent from the actual view port of
  * the text viewer. The annotations of the viewer's whole document are
  * visible in the overview ruler.
- *
+ * <p>
  * This interfaces embodies three contracts:
  * <ul>
  * <li>	The overview ruler retrieves the annotations it presents from an annotation model.
@@ -28,9 +28,10 @@ import org.eclipse.swt.widgets.Control;
  * 		interaction information. This covers the mapping between
  * 		coordinates of the ruler's control and line numbers based
  * 		on the connected text viewer's document (<code>IVerticalRulerInfo</code>).
- * </ul>
+ * </ul></p>
+ * <p>
  * Clients may implement this interface or use the default implementation provided
- * by <code>OverviewlRuler</code>.
+ * by <code>OverviewlRuler</code>.</p>
  *
  * @see org.eclipse.jface.text.ITextViewer
  * @since 2.1
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ISourceViewer.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ISourceViewer.java
index 19fcf733663..ef8660d120a 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ISourceViewer.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ISourceViewer.java
@@ -43,11 +43,11 @@ import org.eclipse.jface.text.ITextViewer;
  * <li>{@link org.eclipse.jface.text.source.ISourceViewerExtension2} since version 3.0
  * allowing source viewers to roll back a previously performed configuration and
  * allows access to the viewer's visual annotation model.</li>
- * </ul>
+ * </ul></p>
  * <p>
  * Clients may implement this interface and its extension interfaces or use the
  * default implementation provided by
- * {@link org.eclipse.jface.text.source.SourceViewer}.
+ * {@link org.eclipse.jface.text.source.SourceViewer}.</p>
  *
  * @see org.eclipse.jface.text.source.ISourceViewerExtension
  * @see org.eclipse.jface.text.source.ISourceViewerExtension2
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IVerticalRuler.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IVerticalRuler.java
index 475918fc13d..ab9f3227148 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IVerticalRuler.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/IVerticalRuler.java
@@ -44,10 +44,11 @@ import org.eclipse.jface.text.ITextViewer;
  * <ul>
  * <li>{@link org.eclipse.jface.text.source.IVerticalRulerExtension} since
  *     version 2.0 introducing setters for font and mouse button activity location.</li>
- * </ul>
+ * </ul></p>
+ * <p>
  * Clients may implement this interface or use the default implementation
  * provided by {@link org.eclipse.jface.text.source.CompositeRuler} and
- * {@link org.eclipse.jface.text.source.VerticalRuler}.
+ * {@link org.eclipse.jface.text.source.VerticalRuler}.</p>
  *
  * @see org.eclipse.jface.text.source.IVerticalRulerExtension
  * @see org.eclipse.jface.text.ITextViewer
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ImageUtilities.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ImageUtilities.java
index 3f1f8d98173..31d61bcfbd7 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ImageUtilities.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/ImageUtilities.java
@@ -19,6 +19,9 @@ import org.eclipse.swt.widgets.Canvas;
 
 /**
  * Provides methods for drawing images onto a canvas.
+ * <p>
+ * This class is neither intended to be instantiated nor instantiated.
+ * </p>
  *
  * @since 3.0
  */
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/MatchingCharacterPainter.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/MatchingCharacterPainter.java
index 2c96fb686e8..a488c90b899 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/MatchingCharacterPainter.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/MatchingCharacterPainter.java
@@ -33,7 +33,7 @@ import org.eclipse.jface.text.Region;
  * This painter can be configured with an
  * {@link org.eclipse.jface.text.source.ICharacterPairMatcher}.
  * <p>
- * Clients instantiate and configure object of this class.
+ * Clients instantiate and configure object of this class.</p>
  *
  * @since 2.1
  */
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/OverviewRuler.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/OverviewRuler.java
index df3b4504ffb..31e44d9a516 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/OverviewRuler.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/OverviewRuler.java
@@ -57,8 +57,9 @@ import org.eclipse.jface.text.source.projection.AnnotationBag;
 /**
  * Ruler presented next to a source viewer showing all annotations of the
  * viewer's annotation model in a compact format. The ruler has the same height
- * as the source viewer.<p>
- * Clients usually instantiate and configure objects of this class.
+ * as the source viewer.
+ * <p>
+ * Clients usually instantiate and configure objects of this class.</p>
  *
  * @since 2.1
  */
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/SourceViewer.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/SourceViewer.java
index 2ab6e2e7a5d..630ac045d93 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/SourceViewer.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/SourceViewer.java
@@ -63,10 +63,10 @@ import org.eclipse.jface.text.reconciler.IReconciler;
  * <p>
  * Clients are supposed to instantiate a source viewer and subsequently to
  * communicate with it exclusively using the <code>ISourceViewer</code>
- * interface.
+ * interface.</p>
  * <p>
  * Clients should not subclass this class as it is rather likely that subclasses
- * will be broken by future releases.
+ * will be broken by future releases.</p>
  */
 public class SourceViewer extends TextViewer implements ISourceViewer, ISourceViewerExtension, ISourceViewerExtension2 {
 
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/SourceViewerConfiguration.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/SourceViewerConfiguration.java
index a6a02d735f5..adb3b2c8ea4 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/source/SourceViewerConfiguration.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/source/SourceViewerConfiguration.java
@@ -49,10 +49,10 @@ import org.eclipse.jface.text.reconciler.IReconciler;
  * should provide a particular configuration setting such as a presentation
  * reconciler. Based on its specific knowledge about the returned object, the
  * configuration might share such objects or compute them according to some
- * rules.
+ * rules.</p>
  * <p>
  * Clients should subclass and override just those methods which must be
- * specific to their needs.
+ * specific to their needs.</p>
  *
  * @see org.eclipse.jface.text.source.ISourceViewer
  */
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/templates/TemplateProposal.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/templates/TemplateProposal.java
index 7eff20da066..aada0cf4044 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/templates/TemplateProposal.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/templates/TemplateProposal.java
@@ -40,7 +40,9 @@ import org.eclipse.jface.text.link.ProposalPosition;
 
 
 /**
- * A template completion proposal. Clients may subclass.
+ * A template completion proposal.
+ * <p>
+ * Clients may subclass.</p>
  *
  * @since 3.0
  */