com.github.aliteralmind.codelet.taglet

Class CodeletTaglet

java.lang.Object

com.github.aliteralmind.codelet.taglet.CodeletTaglet

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

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

Inline JavaDoc taglet for displaying the source code of a class (usually example code). This tag can be used in any kind of Doc.

The only custom code in this class is the NAME field and toString function.

Jamie Ho's UnderlineTaglet was the template used to create this file.

Since:

0.1.0

Author:

Copyright (C) 2014, Jeff Epstein (aliteralmind __DASH__ github __AT__ yahoo __DOT__ com), dual-licensed under the LGPL (version 3.0 or later) or the ASL (version 2.0). See source code for details. http://codelet.aliteralmind.com, https://github.com/aliteralmind/codelet.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME The name of this taglet, which appears immediately after the {@--Equal to CodeletType.SOURCE_CODE.getName()

Constructor Summary

Constructors

Constructor and Description
CodeletTaglet()

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Return the name of this custom tag.
boolean	inConstructor()
boolean	inField()
boolean	inMethod()
boolean	inOverview()
boolean	inPackage()
boolean	inType()
boolean	isInlineTag() Will return true since this is an inline tag.
static void	register(Map taglet_map) Register this Taglet.
String	toString(Tag tag) Given the taglet input of a source-code file (as a fully-qualified class name), this returns the source code for that class, its lines potentially filtered and altered.
String	toString(Tag[] tags) This method should not be called since arrays of inline tags do not exist.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

The name of this taglet, which appears immediately after the {@--Equal to
CodeletType.SOURCE_CODE.getName()

Constructor Detail

CodeletTaglet

public CodeletTaglet()

Method Detail

getName

public String getName()

Return the name of this custom tag.

Specified by:

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

Returns:

#NAME

inField

public boolean inField()

Specified by:

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

Returns:

true since this tag can be used in a field doc comment

inConstructor

public boolean inConstructor()

Specified by:

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

Returns:

true since this tag can be used in a constructor doc comment

inMethod

public boolean inMethod()

Specified by:

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

Returns:

true since this tag can be used in a method doc comment

inOverview

public boolean inOverview()

Specified by:

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

Returns:

true since this tag can be used in an overview doc comment

inPackage

public boolean inPackage()

Specified by:

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

Returns:

true since this tag can be used in a package doc comment

inType

public boolean inType()

Specified by:

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

Returns:

true since this

isInlineTag

public boolean isInlineTag()

Will return true since this is an inline tag.

Specified by:

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

Returns:

true since this is an inline tag.

register

public static void register(Map taglet_map)

Register this Taglet.

Equal to
ComSunJavaDocUtil.registerNewTagletInstance(new CodeletTaglet(), taglet_map)

toString

public String toString(Tag tag)

Given the taglet input of a source-code file (as a fully-qualified class name), this returns the source code for that class, its lines potentially filtered and altered.

Specified by:

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

Parameters:

tag - The Tag representation of this custom tag.

Returns:

CodletComSunJavadocTagProcessor.get(tag)

toString

public String toString(Tag[] tags)

This method should not be called since arrays of inline tags do not exist. Method toString(Tag) should be used to convert this inline tag to a string.

Specified by:

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

Parameters:

tags - the array of Tags representing of this custom tag.