org.tm4j.topicmap.utils .TopicMapDoclet

Description

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.

Inheritance Hierarchy

Field Summary
TOPICMAP_URI
m_atContains
m_atHasField
m_atHasMethod
m_atHasParameters
m_atImplements
m_atImports
m_atOfType
m_atOverrides
m_atReturns
m_atSeeAlso
m_atSuperclassSubclass
m_atThrows
m_baseAddress
m_baseLocator
m_idGen
m_locFactory
m_locParamPosBase
m_otAbstract
m_otComment
m_otDeprecationInfo
m_otProcessed
m_paramShortName
m_paramSortName
m_rtContainee
m_rtContainer
m_rtImplementation
m_rtImportee
m_rtImporter
m_rtInterface
m_rtMethod
m_rtOverride
m_rtOverriden
m_rtReturnedType
m_rtSeeSource
m_rtSeeTarget
m_rtSubclass
m_rtSuperclass
m_rtThrower
m_rtThrown
m_rtType
m_rtTyped
m_themePackagePrivate
m_themePrivate
m_themeProtected
m_topicMap
m_ttAbstractClass
m_ttClass
m_ttError
m_ttException
m_ttExternalizableClass
m_ttField
m_ttInterface
m_ttMethod
m_ttPackage
m_ttParameter
m_ttSerializableClass
m_ttTag
Method Summary
void optionLength(java.lang.String option)
void run(com.sun.javadoc.RootDoc root)
void start(com.sun.javadoc.RootDoc root)

Related Topics

Imports