net.sf.sdedit.taglet
Class SequenceTaglet

java.lang.Object
  net.sf.sdedit.taglet.SequenceTaglet

public class SequenceTaglet
extends Object

This is a taglet that generates sequence diagrams from the contents of @sequence.diagram tags. The diagrams are saved as PNG files in a child directory of the javadoc destination directory (as specified by the -d option). Inside the html pages generated by javadoc, the files are referenced using a relative path, so the references remain valid if the pages are moved - for example, uploaded to a webserver.

If the first line of the tag content is "quoted" it will be used as title for the diagram instead of the default "Sequence Diagram:"

@sequence.diagram are no inline tags and they can be used inside classes, and inside package documentation.

Author:

Markus Strauch, Øystein Lunde

Method Summary

String	getName()
TagletOutput	getTagletOutput(Doc holder, TagletWriter writer)
TagletOutput	getTagletOutput(Tag tag, TagletWriter writer)
boolean	inConstructor()
boolean	inField()
boolean	inMethod()
boolean	inOverview()
boolean	inPackage()
boolean	inType()
boolean	isInlineTag()
static void	register(Map<String,Taglet> tagletMap) Registers an instance of this taglet class.

Methods inherited from class java.lang.Object

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

Method Detail

register

public static void register(Map<String,Taglet> tagletMap)

Registers an instance of this taglet class.

Parameters:

tagletMap - used for registering (maps tag names onto taglets)

getName

public String getName()

See Also:

com.sun.tools.doclets.internal.toolkit.taglets.Taglet#getName()

inConstructor

public boolean inConstructor()

See Also:

com.sun.tools.doclets.internal.toolkit.taglets.Taglet#inConstructor()

inField

public boolean inField()

See Also:

com.sun.tools.doclets.internal.toolkit.taglets.Taglet#inField()

inMethod

public boolean inMethod()

See Also:

com.sun.tools.doclets.internal.toolkit.taglets.Taglet#inMethod()

inOverview

public boolean inOverview()

See Also:

com.sun.tools.doclets.internal.toolkit.taglets.Taglet#inOverview()

inPackage

public boolean inPackage()

See Also:

com.sun.tools.doclets.internal.toolkit.taglets.Taglet#inPackage()

inType

public boolean inType()

See Also:

com.sun.tools.doclets.internal.toolkit.taglets.Taglet#inType()

isInlineTag

public boolean isInlineTag()

See Also:

com.sun.tools.doclets.internal.toolkit.taglets.Taglet#isInlineTag()

getTagletOutput

public TagletOutput getTagletOutput(Tag tag,
                                    TagletWriter writer)
                             throws IllegalArgumentException

Throws:

IllegalArgumentException

See Also:

com.sun.tools.doclets.internal.toolkit.taglets.Taglet#getTagletOutput(com.sun.javadoc.Tag, com.sun.tools.doclets.internal.toolkit.taglets.TagletWriter)

getTagletOutput

public TagletOutput getTagletOutput(Doc holder,
                                    TagletWriter writer)
                             throws IllegalArgumentException

Throws:

IllegalArgumentException

See Also:

com.sun.tools.doclets.internal.toolkit.taglets.Taglet#getTagletOutput(com.sun.javadoc.Doc, com.sun.tools.doclets.internal.toolkit.taglets.TagletWriter)