org.eclipse.jdt.internal.formatter.comment
Class JavaDocRegion

java.lang.Object
  org.eclipse.jface.text.Position
      org.eclipse.jdt.internal.formatter.comment.CommentRegion
          org.eclipse.jdt.internal.formatter.comment.MultiCommentRegion
              org.eclipse.jdt.internal.formatter.comment.JavaDocRegion

All Implemented Interfaces:

IBorderAttributes, ICommentAttributes, IHtmlTagDelimiters, IJavaDocTagConstants

public class JavaDocRegion
extends MultiCommentRegion

Javadoc region in a source code document.

Since:

3.0

Field Summary

Fields inherited from class org.eclipse.jface.text.Position

isDeleted, length, offset

Fields inherited from interface org.eclipse.jdt.internal.formatter.comment.IJavaDocTagConstants

BLOCK_FOOTER, BLOCK_FOOTER_LENGTH, BLOCK_HEADER, BLOCK_HEADER_LENGTH, BLOCK_LINE_PREFIX, BLOCK_LINE_PREFIX_LENGTH, COMMENT_ROOT_TAGS, COMMENT_TAG_PREFIX, JAVADOC_BREAK_TAGS, JAVADOC_BREAK_TAGS_ID, JAVADOC_CLOSED_TAG, JAVADOC_CODE_TAGS, JAVADOC_CODE_TAGS_ID, JAVADOC_HEADER, JAVADOC_HEADER_LENGTH, JAVADOC_IMMUTABLE_TAGS, JAVADOC_IMMUTABLE_TAGS_ID, JAVADOC_NEWLINE_TAGS, JAVADOC_PARAM_TAGS, JAVADOC_SEPARATOR_TAGS, JAVADOC_SEPARATOR_TAGS_ID, JAVADOC_SINGLE_BREAK_TAG, JAVADOC_SINGLE_BREAK_TAG_ID, JAVADOC_SINGLE_TAGS_ID, JAVADOC_SPECIAL_TAGS, JAVADOC_SPECIAL_TAGS_ID, JAVADOC_STAR, JAVADOC_TAG_PREFIX, JAVADOC_TAGS_ID_MASK, JAVADOC_TAGS_INDEX_MASK, LINE_COMMENT_PREFIX, LINE_COMMENT_PREFIX_LENGTH, LINK_TAG_POSTFIX, LINK_TAG_PREFIX, LINK_TAG_PREFIX_STRING

Fields inherited from interface org.eclipse.jdt.internal.formatter.comment.IHtmlTagDelimiters

HTML_CLOSE_PREFIX, HTML_TAG_POSTFIX, HTML_TAG_PREFIX

Fields inherited from interface org.eclipse.jdt.internal.formatter.comment.IBorderAttributes

BORDER_LOWER, BORDER_UPPER

Fields inherited from interface org.eclipse.jdt.internal.formatter.comment.ICommentAttributes

COMMENT_BLANKLINE, COMMENT_BREAK, COMMENT_CLOSE, COMMENT_CODE, COMMENT_FIRST_TOKEN, COMMENT_HTML, COMMENT_IMMUTABLE, COMMENT_NEWLINE, COMMENT_OPEN, COMMENT_PARAGRAPH, COMMENT_PARAMETER, COMMENT_ROOT, COMMENT_SEPARATOR, COMMENT_STARTS_WITH_RANGE_DELIMITER

Constructor Summary

JavaDocRegion(org.eclipse.jface.text.IDocument document, org.eclipse.jface.text.Position position, CodeFormatterVisitor formatter)
Creates a new Javadoc region.

Method Summary

Methods inherited from class org.eclipse.jdt.internal.formatter.comment.CommentRegion

format

Methods inherited from class org.eclipse.jface.text.Position

delete, equals, getLength, getOffset, hashCode, includes, isDeleted, overlapsWith, setLength, setOffset, undelete

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JavaDocRegion

public JavaDocRegion(org.eclipse.jface.text.IDocument document,
                     org.eclipse.jface.text.Position position,
                     CodeFormatterVisitor formatter)

Creates a new Javadoc region.

Parameters:

document - the document which contains the comment region

position - the position of this comment region in the document

formatter - the given formatter