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
org.tm4j.topicmap.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.
|
Method Summary |
private void |
addDocComment(org.tm4j.topicmap.Topic docTopic,
com.sun.javadoc.Doc doc)
|
private void |
addDocIndicator(org.tm4j.topicmap.Topic methodTopic,
com.sun.javadoc.MethodDoc doc)
|
private void |
addDocIndicator(org.tm4j.topicmap.Topic docTopic,
com.sun.javadoc.PackageDoc doc)
|
private void |
addDocIndicator(org.tm4j.topicmap.Topic docTopic,
com.sun.javadoc.ProgramElementDoc doc)
|
private void |
addDocShortComment(org.tm4j.topicmap.Topic docTopic,
com.sun.javadoc.Doc doc)
|
private org.tm4j.topicmap.Association |
createBinaryAssociation(org.tm4j.topicmap.Topic assocType,
org.tm4j.topicmap.Topic r1Type,
org.tm4j.topicmap.Topic r1Player,
org.tm4j.topicmap.Topic r2Type,
org.tm4j.topicmap.Topic r2Player)
|
private org.tm4j.topicmap.Topic |
createTypingTopic(java.lang.String id,
java.lang.String baseName,
java.lang.String subjectIndicator)
|
private void |
createTypingTopics()
|
private org.tm4j.topicmap.Topic |
getTopic(com.sun.javadoc.ClassDoc cls)
|
private org.tm4j.topicmap.Topic |
getTopic(com.sun.javadoc.FieldDoc field)
|
private org.tm4j.topicmap.Topic |
getTopic(com.sun.javadoc.MethodDoc method)
|
private org.tm4j.topicmap.Topic |
getTopic(com.sun.javadoc.PackageDoc pkg)
|
private void |
initialiseTopicMap()
|
static int |
optionLength(java.lang.String option)
|
private void |
processFieldTopic(org.tm4j.topicmap.Topic fieldTopic,
com.sun.javadoc.FieldDoc doc)
|
private void |
processMethodTopic(org.tm4j.topicmap.Topic methodTopic,
com.sun.javadoc.MethodDoc doc)
|
private void |
processPackage(com.sun.javadoc.PackageDoc pkg,
org.tm4j.topicmap.Topic pkgTopic)
|
private void |
processPackageClass(org.tm4j.topicmap.Topic pkgTopic,
com.sun.javadoc.ClassDoc cls)
|
private void |
processPackages(com.sun.javadoc.PackageDoc[] pkgs)
|
private java.lang.String |
processTag(com.sun.javadoc.SeeTag tag)
|
private java.lang.String |
processTag(com.sun.javadoc.Tag tag)
|
private java.lang.String |
processTags(com.sun.javadoc.Tag[] tags)
|
private void |
processTags(org.tm4j.topicmap.Topic topic,
com.sun.javadoc.Tag[] tags)
|
private void |
readOptions(java.lang.String[][] opts)
|
boolean |
run(com.sun.javadoc.RootDoc root)
|
static boolean |
start(com.sun.javadoc.RootDoc root)
|
private void |
writeTopicMap()
|
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PROVIDER_FACTORY_CLASS
protected static java.lang.String PROVIDER_FACTORY_CLASS
TOPICMAP_URI
protected static java.lang.String TOPICMAP_URI
m_providerFactoryClassName
protected java.lang.String m_providerFactoryClassName
m_baseAddress
protected java.lang.String m_baseAddress
m_baseLocator
protected org.tm4j.net.Locator m_baseLocator
m_factory
protected org.tm4j.topicmap.TopicMapFactory m_factory
m_locFactory
protected org.tm4j.net.LocatorFactory m_locFactory
m_topicMap
protected org.tm4j.topicmap.TopicMap m_topicMap
m_ttPackage
protected org.tm4j.topicmap.Topic m_ttPackage
m_ttClass
protected org.tm4j.topicmap.Topic m_ttClass
m_ttAbstractClass
protected org.tm4j.topicmap.Topic m_ttAbstractClass
m_ttExternalizableClass
protected org.tm4j.topicmap.Topic m_ttExternalizableClass
m_ttSerializableClass
protected org.tm4j.topicmap.Topic m_ttSerializableClass
m_ttInterface
protected org.tm4j.topicmap.Topic m_ttInterface
m_ttException
protected org.tm4j.topicmap.Topic m_ttException
m_ttMethod
protected org.tm4j.topicmap.Topic m_ttMethod
m_ttField
protected org.tm4j.topicmap.Topic m_ttField
m_otComment
protected org.tm4j.topicmap.Topic m_otComment
m_otAbstract
protected org.tm4j.topicmap.Topic m_otAbstract
m_otDeprecationInfo
protected org.tm4j.topicmap.Topic m_otDeprecationInfo
m_atSuperclassSubclass
protected org.tm4j.topicmap.Topic m_atSuperclassSubclass
m_rtSuperclass
protected org.tm4j.topicmap.Topic m_rtSuperclass
m_rtSubclass
protected org.tm4j.topicmap.Topic m_rtSubclass
m_atContains
protected org.tm4j.topicmap.Topic m_atContains
m_atHasMethod
protected org.tm4j.topicmap.Topic m_atHasMethod
m_atHasField
protected org.tm4j.topicmap.Topic m_atHasField
m_rtContainer
protected org.tm4j.topicmap.Topic m_rtContainer
m_rtContainee
protected org.tm4j.topicmap.Topic m_rtContainee
m_atImports
protected org.tm4j.topicmap.Topic m_atImports
m_rtImporter
protected org.tm4j.topicmap.Topic m_rtImporter
m_rtImportee
protected org.tm4j.topicmap.Topic m_rtImportee
m_atImplements
protected org.tm4j.topicmap.Topic m_atImplements
m_rtInterface
protected org.tm4j.topicmap.Topic m_rtInterface
m_rtImplementation
protected org.tm4j.topicmap.Topic m_rtImplementation
m_atThrows
protected org.tm4j.topicmap.Topic m_atThrows
m_rtThrower
protected org.tm4j.topicmap.Topic m_rtThrower
m_rtThrown
protected org.tm4j.topicmap.Topic m_rtThrown
m_atReturns
protected org.tm4j.topicmap.Topic m_atReturns
m_rtReturnedType
protected org.tm4j.topicmap.Topic m_rtReturnedType
m_rtMethod
protected org.tm4j.topicmap.Topic m_rtMethod
m_atOverrides
protected org.tm4j.topicmap.Topic m_atOverrides
m_rtOverriden
protected org.tm4j.topicmap.Topic m_rtOverriden
m_rtOverride
protected org.tm4j.topicmap.Topic m_rtOverride
m_paramShortName
protected org.tm4j.topicmap.Topic m_paramShortName
m_idGen
protected IDGenerator m_idGen
m_outFileName
java.lang.String m_outFileName
TopicMapDoclet
public TopicMapDoclet()
start
public static boolean start(com.sun.javadoc.RootDoc root)
run
public boolean run(com.sun.javadoc.RootDoc root)
readOptions
private void readOptions(java.lang.String[][] opts)
optionLength
public static int optionLength(java.lang.String option)
initialiseTopicMap
private void initialiseTopicMap()
createTypingTopics
private void createTypingTopics()
throws org.tm4j.topicmap.TopicMapProcessingException,
org.tm4j.net.LocatorFactoryException,
java.beans.PropertyVetoException
createTypingTopic
private org.tm4j.topicmap.Topic createTypingTopic(java.lang.String id,
java.lang.String baseName,
java.lang.String subjectIndicator)
throws org.tm4j.topicmap.TopicMapProcessingException,
org.tm4j.net.LocatorFactoryException,
java.beans.PropertyVetoException
processPackages
private void processPackages(com.sun.javadoc.PackageDoc[] pkgs)
getTopic
private org.tm4j.topicmap.Topic getTopic(com.sun.javadoc.PackageDoc pkg)
throws org.tm4j.net.LocatorFactoryException,
org.tm4j.topicmap.TopicMapProcessingException,
java.beans.PropertyVetoException
getTopic
private org.tm4j.topicmap.Topic getTopic(com.sun.javadoc.ClassDoc cls)
throws org.tm4j.net.LocatorFactoryException,
org.tm4j.topicmap.TopicMapProcessingException,
org.tm4j.topicmap.DuplicateObjectIDException,
java.beans.PropertyVetoException
getTopic
private org.tm4j.topicmap.Topic getTopic(com.sun.javadoc.MethodDoc method)
throws org.tm4j.net.LocatorFactoryException,
org.tm4j.topicmap.TopicMapProcessingException,
org.tm4j.topicmap.DuplicateObjectIDException,
java.beans.PropertyVetoException
getTopic
private org.tm4j.topicmap.Topic getTopic(com.sun.javadoc.FieldDoc field)
throws org.tm4j.topicmap.TopicMapProcessingException,
java.beans.PropertyVetoException,
org.tm4j.net.LocatorFactoryException
processPackage
private void processPackage(com.sun.javadoc.PackageDoc pkg,
org.tm4j.topicmap.Topic pkgTopic)
throws org.tm4j.net.LocatorFactoryException,
org.tm4j.net.LocatorResolutionException,
org.tm4j.topicmap.TopicMapProcessingException,
java.beans.PropertyVetoException
processPackageClass
private void processPackageClass(org.tm4j.topicmap.Topic pkgTopic,
com.sun.javadoc.ClassDoc cls)
throws org.tm4j.net.LocatorFactoryException,
org.tm4j.net.LocatorResolutionException,
org.tm4j.topicmap.TopicMapProcessingException,
java.beans.PropertyVetoException
processMethodTopic
private void processMethodTopic(org.tm4j.topicmap.Topic methodTopic,
com.sun.javadoc.MethodDoc doc)
throws org.tm4j.topicmap.TopicMapProcessingException,
org.tm4j.topicmap.DuplicateObjectIDException,
org.tm4j.net.LocatorFactoryException,
org.tm4j.net.LocatorResolutionException,
java.beans.PropertyVetoException
processFieldTopic
private void processFieldTopic(org.tm4j.topicmap.Topic fieldTopic,
com.sun.javadoc.FieldDoc doc)
addDocComment
private void addDocComment(org.tm4j.topicmap.Topic docTopic,
com.sun.javadoc.Doc doc)
throws org.tm4j.topicmap.DuplicateObjectIDException,
java.beans.PropertyVetoException
addDocShortComment
private void addDocShortComment(org.tm4j.topicmap.Topic docTopic,
com.sun.javadoc.Doc doc)
throws org.tm4j.topicmap.DuplicateObjectIDException,
java.beans.PropertyVetoException
processTags
private void processTags(org.tm4j.topicmap.Topic topic,
com.sun.javadoc.Tag[] tags)
throws org.tm4j.topicmap.DuplicateObjectIDException,
java.beans.PropertyVetoException,
org.tm4j.net.LocatorFactoryException,
org.tm4j.topicmap.TopicMapProcessingException
processTags
private java.lang.String processTags(com.sun.javadoc.Tag[] tags)
processTag
private java.lang.String processTag(com.sun.javadoc.Tag tag)
processTag
private java.lang.String processTag(com.sun.javadoc.SeeTag tag)
addDocIndicator
private void addDocIndicator(org.tm4j.topicmap.Topic methodTopic,
com.sun.javadoc.MethodDoc doc)
addDocIndicator
private void addDocIndicator(org.tm4j.topicmap.Topic docTopic,
com.sun.javadoc.ProgramElementDoc doc)
throws org.tm4j.net.LocatorFactoryException,
java.beans.PropertyVetoException
addDocIndicator
private void addDocIndicator(org.tm4j.topicmap.Topic docTopic,
com.sun.javadoc.PackageDoc doc)
throws org.tm4j.net.LocatorFactoryException,
java.beans.PropertyVetoException
createBinaryAssociation
private org.tm4j.topicmap.Association createBinaryAssociation(org.tm4j.topicmap.Topic assocType,
org.tm4j.topicmap.Topic r1Type,
org.tm4j.topicmap.Topic r1Player,
org.tm4j.topicmap.Topic r2Type,
org.tm4j.topicmap.Topic r2Player)
throws org.tm4j.topicmap.DuplicateObjectIDException,
org.tm4j.topicmap.TopicMapProcessingException,
java.beans.PropertyVetoException
writeTopicMap
private void writeTopicMap()
JAVADOC | 
SOURCE | 
DOWNLOAD | NESTED | FIELD | CONSTR | METHOD