com.amazonaws.codesamples

Class SampleCodeTaglet

java.lang.Object

com.amazonaws.codesamples.SampleCodeTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public class SampleCodeTaglet
extends java.lang.Object
implements com.sun.tools.doclets.Taglet

Taglet that retrieves and injects sample code blocks into sections of Javadocs marked with @sample tags. Samples are retrieved from an intermediate XML format, formatted into HTML blocks, and inserted into the final Javadoc. Example tag: @sample S3.FooSample

Constructor Summary

Constructors

Constructor and Description
SampleCodeTaglet()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName()
boolean	inConstructor()
boolean	inField()
boolean	inMethod()
boolean	inOverview()
boolean	inPackage()
boolean	inType()
boolean	isInlineTag()
static void	register(java.util.Map<java.lang.String,com.sun.tools.doclets.Taglet> tagletMap)
java.lang.String	toString(com.sun.javadoc.Tag tag)
java.lang.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

SampleCodeTaglet

public SampleCodeTaglet()

Method Detail

getName

public java.lang.String getName()

Specified by:

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

inConstructor

public boolean inConstructor()

Specified by:

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

inField

public boolean inField()

Specified by:

inField 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

register

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

toString

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

Specified by:

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

toString

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

Specified by:

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