com.basho.riak.client.javadoc

Class RiakThreadSafetyTaglet

java.lang.Object

com.basho.riak.client.javadoc.RiakThreadSafetyTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public class RiakThreadSafetyTaglet
extends Object
implements com.sun.tools.doclets.Taglet

Taglet for our docs to describe the thread safety of a class or method

Since:

2.0

Author:

Brian Roach

Constructor Summary

Constructors

Constructor and Description
RiakThreadSafetyTaglet()

Method Summary

Methods

Modifier and Type	Method and Description
String	getName()
boolean	inConstructor()
boolean	inField()
boolean	inMethod()
boolean	inOverview()
boolean	inPackage()
boolean	inType()
boolean	isInlineTag()
static void	register(Map<String,com.sun.tools.doclets.Taglet> tagletMap)
String	toString(com.sun.javadoc.Tag tag)
String	toString(com.sun.javadoc.Tag[] tags)

Methods inherited from class java.lang.Object

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

Constructor Detail

RiakThreadSafetyTaglet

public RiakThreadSafetyTaglet()

Method Detail

inField

public boolean inField()

Specified by:

inField in interface com.sun.tools.doclets.Taglet

inConstructor

public boolean inConstructor()

Specified by:

inConstructor in interface com.sun.tools.doclets.Taglet

inMethod

public boolean inMethod()

Specified by:

inMethod in interface com.sun.tools.doclets.Taglet

inOverview

public boolean inOverview()

Specified by:

inOverview in interface com.sun.tools.doclets.Taglet

inPackage

public boolean inPackage()

Specified by:

inPackage in interface com.sun.tools.doclets.Taglet

inType

public boolean inType()

Specified by:

inType in interface com.sun.tools.doclets.Taglet

isInlineTag

public boolean isInlineTag()

Specified by:

isInlineTag in interface com.sun.tools.doclets.Taglet

getName

public String getName()

Specified by:

getName in interface com.sun.tools.doclets.Taglet

toString

public String toString(com.sun.javadoc.Tag tag)

Specified by:

toString in interface com.sun.tools.doclets.Taglet

toString

public String toString(com.sun.javadoc.Tag[] tags)

Specified by:

toString in interface com.sun.tools.doclets.Taglet

register

public static void register(Map<String,com.sun.tools.doclets.Taglet> tagletMap)