org.tm4j.topicmap.utils
Class TopicMapDoclet

java.lang.Object
  org.tm4j.topicmap.utils.TopicMapDoclet

public class TopicMapDoclet

extends java.lang.Object

A custom Javadoc doclet, to be used for generating topic mapped API documentation. There are three options you may specify when invoking this doclet:

• -out — the output file to write the generated topic map to. You must specify this option or no topic map will be written.
• -provider — the class name of the TopicMapProviderFactory you wish to use. If this is not specified, the org.tm4j.topicmap.memory.TopicMapProviderFactoryImpl class is used.
• -baseuri — the base URI to be used for the xml:base attribute of the topic map's root element. If this is not specified, http://tm4j.org/topicmaps/javadoc.xtm is used.

Author:

Kal Ahmed

Field Summary

protected Topic	m_atContains
protected Topic	m_atHasField
protected Topic	m_atHasMethod
protected Topic	m_atHasParameters
protected Topic	m_atImplements
protected Topic	m_atImports
protected Topic	m_atOfType
protected Topic	m_atOverrides
protected Topic	m_atReturns
protected Topic	m_atSeeAlso
protected Topic	m_atSuperclassSubclass
protected Topic	m_atThrows
protected java.lang.String	m_baseAddress
protected Locator	m_baseLocator
protected IDGenerator	m_idGen
protected LocatorFactory	m_locFactory
protected Locator	m_locParamPosBase
protected Topic	m_otAbstract
protected Topic	m_otComment
protected Topic	m_otDeprecationInfo
protected Topic	m_otProcessed
protected Topic	m_paramShortName
protected Topic	m_paramSortName
protected Topic	m_rtContainee
protected Topic	m_rtContainer
protected Topic	m_rtImplementation
protected Topic	m_rtImportee
protected Topic	m_rtImporter
protected Topic	m_rtInterface
protected Topic	m_rtMethod
protected Topic	m_rtOverride
protected Topic	m_rtOverriden
protected Topic	m_rtReturnedType
protected Topic	m_rtSeeSource
protected Topic	m_rtSeeTarget
protected Topic	m_rtSubclass
protected Topic	m_rtSuperclass
protected Topic	m_rtThrower
protected Topic	m_rtThrown
protected Topic	m_rtType
protected Topic	m_rtTyped
protected Topic	m_themePackagePrivate
protected Topic	m_themePrivate
protected Topic	m_themeProtected
protected TopicMap	m_topicMap
protected Topic	m_ttAbstractClass
protected Topic	m_ttClass
protected Topic	m_ttError
protected Topic	m_ttException
protected Topic	m_ttExternalizableClass
protected Topic	m_ttField
protected Topic	m_ttInterface
protected Topic	m_ttMethod
protected Topic	m_ttPackage
protected Topic	m_ttParameter
protected Topic	m_ttSerializableClass
protected Topic	m_ttTag
protected static java.lang.String	TOPICMAP_URI

Constructor Summary

TopicMapDoclet()

Method Summary

static int	optionLength(java.lang.String option)
boolean	run(com.sun.javadoc.RootDoc root)
static boolean	start(com.sun.javadoc.RootDoc root)

Methods inherited from class java.lang.Object

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

Field Detail

TOPICMAP_URI

protected static java.lang.String TOPICMAP_URI

m_baseAddress

protected java.lang.String m_baseAddress

m_baseLocator

protected Locator m_baseLocator

m_locFactory

protected LocatorFactory m_locFactory

m_topicMap

protected TopicMap m_topicMap

m_ttPackage

protected Topic m_ttPackage

m_ttClass

protected Topic m_ttClass

m_ttAbstractClass

protected Topic m_ttAbstractClass

m_ttExternalizableClass

protected Topic m_ttExternalizableClass

m_ttSerializableClass

protected Topic m_ttSerializableClass

m_ttInterface

protected Topic m_ttInterface

m_ttException

protected Topic m_ttException

m_ttError

protected Topic m_ttError

m_ttMethod

protected Topic m_ttMethod

m_ttField

protected Topic m_ttField

m_ttParameter

protected Topic m_ttParameter

m_ttTag

protected Topic m_ttTag

m_otComment

protected Topic m_otComment

m_otAbstract

protected Topic m_otAbstract

m_otDeprecationInfo

protected Topic m_otDeprecationInfo

m_otProcessed

protected Topic m_otProcessed

m_atSuperclassSubclass

protected Topic m_atSuperclassSubclass

m_rtSuperclass

protected Topic m_rtSuperclass

m_rtSubclass

protected Topic m_rtSubclass

m_atContains

protected Topic m_atContains

m_atHasMethod

protected Topic m_atHasMethod

m_atHasField

protected Topic m_atHasField

m_rtContainer

protected Topic m_rtContainer

m_rtContainee

protected Topic m_rtContainee

m_atImports

protected Topic m_atImports

m_rtImporter

protected Topic m_rtImporter

m_rtImportee

protected Topic m_rtImportee

m_atImplements

protected Topic m_atImplements

m_rtInterface

protected Topic m_rtInterface

m_rtImplementation

protected Topic m_rtImplementation

m_atThrows

protected Topic m_atThrows

m_rtThrower

protected Topic m_rtThrower

m_rtThrown

protected Topic m_rtThrown

m_atReturns

protected Topic m_atReturns

m_rtReturnedType

protected Topic m_rtReturnedType

m_rtMethod

protected Topic m_rtMethod

m_atOverrides

protected Topic m_atOverrides

m_rtOverriden

protected Topic m_rtOverriden

m_rtOverride

protected Topic m_rtOverride

m_atHasParameters

protected Topic m_atHasParameters

m_locParamPosBase

protected Locator m_locParamPosBase

m_atOfType

protected Topic m_atOfType

m_rtType

protected Topic m_rtType

m_rtTyped

protected Topic m_rtTyped

m_atSeeAlso

protected Topic m_atSeeAlso

m_rtSeeSource

protected Topic m_rtSeeSource

m_rtSeeTarget

protected Topic m_rtSeeTarget

m_themeProtected

protected Topic m_themeProtected

m_themePrivate

protected Topic m_themePrivate

m_themePackagePrivate

protected Topic m_themePackagePrivate

m_paramShortName

protected Topic m_paramShortName

m_paramSortName

protected Topic m_paramSortName

m_idGen

protected IDGenerator m_idGen

Constructor Detail

TopicMapDoclet

public TopicMapDoclet()

Method Detail

start

public static boolean start(com.sun.javadoc.RootDoc root)

run

public boolean run(com.sun.javadoc.RootDoc root)

optionLength

public static int optionLength(java.lang.String option)