org.tm4j.topicmap.utils .TopicMapDoclet

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.

java.lang.Object

TopicMapDoclet

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)

@author : Kal Ahmed

Javadoc Processing Complete : yes

Imports

com.sun.javadoc.ClassDoc [ Importee ]

com.sun.javadoc.Doc [ Importee ]

com.sun.javadoc.FieldDoc [ Importee ]

com.sun.javadoc.MemberDoc [ Importee ]

com.sun.javadoc.MethodDoc [ Importee ]

com.sun.javadoc.PackageDoc [ Importee ]

com.sun.javadoc.ParamTag [ Importee ]

com.sun.javadoc.Parameter [ Importee ]

com.sun.javadoc.ProgramElementDoc [ Importee ]

com.sun.javadoc.RootDoc [ Importee ]

com.sun.javadoc.SeeTag [ Importee ]

com.sun.javadoc.Tag [ Importee ]

com.sun.javadoc.ThrowsTag [ Importee ]

com.sun.javadoc.Type [ Importee ]

java.beans.PropertyVetoException [ Importee ]

java.io.File [ Importee ]

java.io.FileNotFoundException [ Importee ]

java.io.FileOutputStream [ Importee ]

java.io.IOException [ Importee ]

java.lang [ Importee ]

java.text.DecimalFormat [ Importee ]

org.apache.xml.serialize.OutputFormat [ Importee ]

org.apache.xml.serialize.XMLSerializer [ Importee ]

org.tm4j.net.Locator [ Importee ]

org.tm4j.net.LocatorFactory [ Importee ]

org.tm4j.net.LocatorFactoryException [ Importee ]

org.tm4j.net.LocatorResolutionException [ Importee ]

org.tm4j.topicmap.Association [ Importee ]

org.tm4j.topicmap.BaseName [ Importee ]

org.tm4j.topicmap.DuplicateObjectIDException [ Importee ]

org.tm4j.topicmap.Member [ Importee ]

org.tm4j.topicmap.Occurrence [ Importee ]

org.tm4j.topicmap.ScopedObject [ Importee ]

org.tm4j.topicmap.Topic [ Importee ]

org.tm4j.topicmap.TopicMap [ Importee ]

org.tm4j.topicmap.TopicMapProcessingException [ Importee ]

org.tm4j.topicmap.TopicMapProvider [ Importee ]

org.tm4j.topicmap.TopicMapProviderException [ Importee ]

org.tm4j.topicmap.TopicMapProviderFactory [ Importee ]

org.tm4j.topicmap.Variant [ Importee ]

org.tm4j.topicmap.VariantName [ Importee ]

org.tm4j.topicmap.XTMPSI [ Importee ]

Is Contained By

org.tm4j.topicmap.utils [ Container ]