Class JavadocParser
java.lang.Object
org.aspectj.org.eclipse.jdt.internal.compiler.parser.AbstractCommentParser
org.aspectj.org.eclipse.jdt.internal.compiler.parser.JavadocParser
- All Implemented Interfaces:
JavadocTagConstants
- Direct Known Subclasses:
CompletionJavadocParser
,SelectionJavadocParser
,SourceJavadocParser
Parser specialized for decoding javadoc comments
-
Field Summary
FieldsFields inherited from class org.aspectj.org.eclipse.jdt.internal.compiler.parser.AbstractCommentParser
abort, ARGUMENT_RECOVERY, ARGUMENT_TYPE_RECOVERY, AST_STACK_INCREMENT, astLengthPtr, astLengthStack, astPtr, astStack, checkDocComment, COMPIL_PARSER, COMPLETION_PARSER, complianceLevel, deprecated, DOM_PARSER, EMPTY_ARGUMENT_RECOVERY, firstTagPosition, FORMATTER_COMMENT_PARSER, identifierLengthPtr, identifierLengthStack, identifierPositionStack, identifierPtr, identifierStack, index, inheritedPositions, inheritedPositionsPtr, inlineTagStart, inlineTagStarted, javadocEnd, javadocStart, javadocTextEnd, javadocTextStart, kind, lastBlockTagValue, lastIdentifierEndPosition, lineEnd, lineEnds, lineStarted, memberStart, PARSER_KIND, providesReferencesPtr, providesReferencesStack, QUALIFIED_NAME_RECOVERY, reportProblems, returnStatement, scanner, SELECTION_PARSER, setJavadocPositions, source, SOURCE_PARSER, sourceLevel, sourceParser, starPosition, tagSourceEnd, tagSourceStart, tagValue, TEXT_PARSE, TEXT_VERIF, textStart, tokenPreviousPosition, usesReferencesPtr, usesReferencesStack
Fields inherited from interface org.aspectj.org.eclipse.jdt.internal.compiler.parser.JavadocTagConstants
ALL_TAGS_LENGTH, BLOCK_IDX, BLOCK_TAGS, BLOCK_TAGS_LENGTH, CLASS_TAGS, COMPILATION_UNIT_TAGS, FIELD_TAGS, HREF_TAG, INLINE_IDX, INLINE_TAGS, INLINE_TAGS_LENGTH, JAVADOC_TAG_TYPE, METHOD_TAGS, MODULE_TAGS, NO_TAG_VALUE, ORDERED_TAGS_NUMBER, PACKAGE_TAGS, PARAM_TAG_EXPECTED_ORDER, SEE_TAG_EXPECTED_ORDER, TAG_API_NOTE, TAG_API_NOTE_LENGTH, TAG_API_NOTE_VALUE, TAG_AUTHOR, TAG_AUTHOR_LENGTH, TAG_AUTHOR_VALUE, TAG_CATEGORY, TAG_CATEGORY_LENGTH, TAG_CATEGORY_VALUE, TAG_CODE, TAG_CODE_LENGTH, TAG_CODE_VALUE, TAG_DEPRECATED, TAG_DEPRECATED_LENGTH, TAG_DEPRECATED_VALUE, TAG_DOC_ROOT, TAG_DOC_ROOT_LENGTH, TAG_DOC_ROOT_VALUE, TAG_EXCEPTION, TAG_EXCEPTION_LENGTH, TAG_EXCEPTION_VALUE, TAG_HIDDEN, TAG_HIDDEN_LENGTH, TAG_HIDDEN_VALUE, TAG_IMPL_NOTE, TAG_IMPL_NOTE_LENGTH, TAG_IMPL_NOTE_VALUE, TAG_IMPL_SPEC, TAG_IMPL_SPEC_LENGTH, TAG_IMPL_SPEC_VALUE, TAG_INDEX, TAG_INDEX_LENGTH, TAG_INDEX_VALUE, TAG_INHERITDOC, TAG_INHERITDOC_LENGTH, TAG_INHERITDOC_VALUE, TAG_LINK, TAG_LINK_LENGTH, TAG_LINK_VALUE, TAG_LINKPLAIN, TAG_LINKPLAIN_LENGTH, TAG_LINKPLAIN_VALUE, TAG_LITERAL, TAG_LITERAL_LENGTH, TAG_LITERAL_VALUE, TAG_NAMES, TAG_OTHERS_VALUE, TAG_PARAM, TAG_PARAM_LENGTH, TAG_PARAM_VALUE, TAG_PROVIDES, TAG_PROVIDES_LENGTH, TAG_PROVIDES_VALUE, TAG_RETURN, TAG_RETURN_LENGTH, TAG_RETURN_VALUE, TAG_SEE, TAG_SEE_LENGTH, TAG_SEE_VALUE, TAG_SERIAL, TAG_SERIAL_DATA, TAG_SERIAL_DATA_LENGTH, TAG_SERIAL_DATA_VALUE, TAG_SERIAL_FIELD, TAG_SERIAL_FIELD_LENGTH, TAG_SERIAL_FIELD_VALUE, TAG_SERIAL_LENGTH, TAG_SERIAL_VALUE, TAG_SINCE, TAG_SINCE_LENGTH, TAG_SINCE_VALUE, TAG_SUMMARY, TAG_SUMMARY_LENGTH, TAG_SUMMARY_VALUE, TAG_SYSTEM_PROPERTY, TAG_SYSTEM_PROPERTY_LENGTH, TAG_SYSTEM_PROPERTY_VALUE, TAG_THROWS, TAG_THROWS_LENGTH, TAG_THROWS_VALUE, TAG_TYPE_BLOCK, TAG_TYPE_INLINE, TAG_TYPE_NONE, TAG_USES, TAG_USES_LENGTH, TAG_USES_VALUE, TAG_VALUE, TAG_VALUE_LENGTH, TAG_VALUE_VALUE, TAG_VERSION, TAG_VERSION_LENGTH, TAG_VERSION_VALUE, THROWS_TAG_EXPECTED_ORDER
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
checkDeprecation(int commentPtr)
protected Object
createArgumentReference(char[] name, int dim, boolean isVarargs, Object typeRef, long[] dimPositions, long argNamePos)
protected Object
createFieldReference(Object receiver)
protected Object
createMethodReference(Object receiver, List arguments)
protected JavadocModuleReference
createModuleReference(int moduleRefTokenCount)
protected Object
createModuleTypeReference(int primitiveToken, int moduleRefTokenCount)
protected Object
protected void
protected Object
createTypeReference(int primitiveToken)
protected TypeDeclaration
protected void
protected boolean
protected boolean
protected boolean
protected void
protected boolean
parseTag(int previousPosition)
protected boolean
protected boolean
protected boolean
pushParamName(boolean isTypeParam)
protected boolean
pushProvidesReference(Object typeRef)
protected boolean
pushSeeRef(Object statement)
protected void
pushText(int start, int end)
protected boolean
pushThrowName(Object typeRef)
protected boolean
pushUsesReference(Object typeRef)
protected void
refreshInlineTagPosition(int previousPosition)
protected void
toString()
protected void
Methods inherited from class org.aspectj.org.eclipse.jdt.internal.compiler.parser.AbstractCommentParser
commentParse, consumeToken, createFakeReference, getCurrentTokenType, getTokenEndPosition, parseArguments, parseHref, parseHtmlTag, parseIdentifierTag, parseMember, parseQualifiedName, parseQualifiedName, parseReference, parseReference, peekChar, pushIdentifier, pushOnAstStack, readChar, readToken, readTokenAndConsume, readTokenSafely, recordInheritedPosition, setInlineTagStarted, setSourceComplianceLevel, syntaxRecoverModuleQualifiedName, syntaxRecoverQualifiedName, updateLineEnd, verifyEndLine, verifySpaceOrEndComment
-
Field Details
-
docComment
-
shouldReportProblems
public boolean shouldReportProblems
-
-
Constructor Details
-
JavadocParser
-
-
Method Details
-
checkDeprecation
public boolean checkDeprecation(int commentPtr) -
createArgumentReference
protected Object createArgumentReference(char[] name, int dim, boolean isVarargs, Object typeRef, long[] dimPositions, long argNamePos) throws InvalidInputException- Specified by:
createArgumentReference
in classAbstractCommentParser
- Throws:
InvalidInputException
-
createFieldReference
- Specified by:
createFieldReference
in classAbstractCommentParser
- Throws:
InvalidInputException
-
createMethodReference
protected Object createMethodReference(Object receiver, List arguments) throws InvalidInputException- Specified by:
createMethodReference
in classAbstractCommentParser
- Throws:
InvalidInputException
-
createReturnStatement
- Overrides:
createReturnStatement
in classAbstractCommentParser
-
createTag
protected void createTag()- Specified by:
createTag
in classAbstractCommentParser
-
createTypeReference
- Specified by:
createTypeReference
in classAbstractCommentParser
-
createModuleReference
-
createModuleTypeReference
- Specified by:
createModuleTypeReference
in classAbstractCommentParser
-
getParsedTypeDeclaration
-
parseThrows
protected boolean parseThrows()- Overrides:
parseThrows
in classAbstractCommentParser
-
parseReturn
protected boolean parseReturn() -
parseSimpleTag
protected void parseSimpleTag() -
parseTag
- Specified by:
parseTag
in classAbstractCommentParser
- Throws:
InvalidInputException
-
parseInheritDocTag
protected void parseInheritDocTag() -
parseParam
- Overrides:
parseParam
in classAbstractCommentParser
- Throws:
InvalidInputException
-
pushParamName
protected boolean pushParamName(boolean isTypeParam)- Specified by:
pushParamName
in classAbstractCommentParser
-
pushSeeRef
- Specified by:
pushSeeRef
in classAbstractCommentParser
-
pushText
protected void pushText(int start, int end)- Overrides:
pushText
in classAbstractCommentParser
-
pushThrowName
- Specified by:
pushThrowName
in classAbstractCommentParser
-
refreshInlineTagPosition
protected void refreshInlineTagPosition(int previousPosition)- Overrides:
refreshInlineTagPosition
in classAbstractCommentParser
-
refreshReturnStatement
protected void refreshReturnStatement()- Overrides:
refreshReturnStatement
in classAbstractCommentParser
-
toString
- Overrides:
toString
in classAbstractCommentParser
-
updateDocComment
protected void updateDocComment()- Specified by:
updateDocComment
in classAbstractCommentParser
-
parseUsesReference
protected boolean parseUsesReference() -
pushUsesReference
-
parseProvidesReference
protected boolean parseProvidesReference() -
pushProvidesReference
-