org.fourthline.lemma.reader.javadoc

Class JavadocReader

java.lang.Object

org.fourthline.lemma.reader.AbstractReader

org.fourthline.lemma.reader.javadoc.AbstractJavadocReader

org.fourthline.lemma.reader.javadoc.JavadocReader

All Implemented Interfaces:

Reader

public class JavadocReader
extends AbstractJavadocReader

Reads title and content from a Javadoc Doc, handles javadoc:// scheme.

This reader understands the individual Javadoc "tags", it wraps these individual parts of each Javadoc comment and validates the whole.

Author:

Christian Bauer

Field Summary

Fields inherited from class org.fourthline.lemma.reader.javadoc.AbstractJavadocReader

CONTEXT_ROOT_DOC

Constructor Summary

Constructors

Constructor and Description
JavadocReader()

Method Summary

Modifier and Type	Method and Description
protected void	appendContent(org.seamless.xhtml.XHTMLElement parent, com.sun.javadoc.Doc doc, CitationAnchor citation, String titleString)
protected String	getLinkLabel(com.sun.javadoc.SeeTag tag)
protected String	getLinkReference(com.sun.javadoc.SeeTag tag, AnchorAddress address)
protected AnchorAddress	getLinkReferenceAddress(com.sun.javadoc.SeeTag tag)
protected org.seamless.xhtml.XHTML	read(CitationAnchor citation, Context context, com.sun.javadoc.RootDoc rootDoc)
protected org.seamless.xhtml.XHTML	read(com.sun.javadoc.Doc doc, CitationAnchor citation, boolean uniqueId)
protected String	readTagCode(com.sun.javadoc.Tag tag)
protected String	readTags(com.sun.javadoc.Tag[] tags)
protected String	readTagSee(com.sun.javadoc.SeeTag seeTag)
protected String	readTagText(com.sun.javadoc.Tag tag)
protected String	readTitle(com.sun.javadoc.Doc doc, CitationAnchor citation)

Methods inherited from class org.fourthline.lemma.reader.javadoc.AbstractJavadocReader

findTargetDoc, read, resolveThisReferences

Methods inherited from class org.fourthline.lemma.reader.AbstractReader

addFilePath, appendTitle, getParser, getXPath, isGenerateId, resolveFile

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JavadocReader

public JavadocReader()

Method Detail

read

protected org.seamless.xhtml.XHTML read(CitationAnchor citation,
                                        Context context,
                                        com.sun.javadoc.RootDoc rootDoc)

Specified by:

read in class AbstractJavadocReader

read

protected org.seamless.xhtml.XHTML read(com.sun.javadoc.Doc doc,
                                        CitationAnchor citation,
                                        boolean uniqueId)

readTitle

protected String readTitle(com.sun.javadoc.Doc doc,
                           CitationAnchor citation)

appendContent

protected void appendContent(org.seamless.xhtml.XHTMLElement parent,
                             com.sun.javadoc.Doc doc,
                             CitationAnchor citation,
                             String titleString)

readTags

protected String readTags(com.sun.javadoc.Tag[] tags)

readTagText

protected String readTagText(com.sun.javadoc.Tag tag)

readTagSee

protected String readTagSee(com.sun.javadoc.SeeTag seeTag)

readTagCode

protected String readTagCode(com.sun.javadoc.Tag tag)

getLinkReferenceAddress

protected AnchorAddress getLinkReferenceAddress(com.sun.javadoc.SeeTag tag)

getLinkReference

protected String getLinkReference(com.sun.javadoc.SeeTag tag,
                                  AnchorAddress address)

getLinkLabel

protected String getLinkLabel(com.sun.javadoc.SeeTag tag)