com.github.aliteralmind.codelet.taglet

Class ComSunJavaDocUtil

java.lang.Object

com.github.aliteralmind.codelet.taglet.ComSunJavaDocUtil

public class ComSunJavaDocUtil
extends Object

Generically-useful utilities related to com.sun.javadoc.

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

Constructor Summary

Constructors

Constructor and Description
ComSunJavaDocUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static String	getEnclosingPackageName(Tag tag) Get the package of the tag-containing JavaDoc page.
static String	getEnclosingSimpleName(Tag tag, IncludePostClassName include_postClassName) Get the tag-containing JavaDoc page's post-package name.
static PackageDoc	getPackageDoc(Tag tag) Get the object containing the "package" of the tag-containing JavaDoc page.
static String	getRelativeUrlToDocRoot(Tag tag) Get the relative url whose value is equivalent to {@docRoot}.
static void	registerNewTagletInstance(com.sun.tools.doclets.Taglet taglet, Map map) Register a Taglet as required by JavaDoc.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComSunJavaDocUtil

public ComSunJavaDocUtil()

Method Detail

registerNewTagletInstance

public static void registerNewTagletInstance(com.sun.tools.doclets.Taglet taglet,
                             Map map)

Register a Taglet as required by JavaDoc.

(Why is the map parameter type-erased? What generics does it need?)

Steps

1. If a taglet with the name equal to taglet.getName() already exists in the map, remove it.
2. taglet is added to the map, with its name as the key.

Parameters:

taglet - The taglet to register. May not be null.

map - The map to register this tag to. May not be null.

Since:

0.1.1

getRelativeUrlToDocRoot

public static final String getRelativeUrlToDocRoot(Tag tag)

Get the relative url whose value is equivalent to {@docRoot}.

Returns:

JavaDocUtil.getRelativeUrlToDocRoot(getEnclosingPackageName(tag))

getEnclosingPackageName

public static final String getEnclosingPackageName(Tag tag)

Get the package of the tag-containing JavaDoc page.

Returns:

If getPackageDoc(tag) is

• null: ""
• non-null: Its name.

getEnclosingSimpleName

public static final String getEnclosingSimpleName(Tag tag,
                            IncludePostClassName include_postClassName)

Get the tag-containing JavaDoc page's post-package name.

Parameters:

tag - May not be null.

include_postClassName - If the taglet is in the class JavaDoc-block, The classes generics, if any, are included in its simple name. If the taglet is in a function's JavaDoc-block, its name and parameters are included. If this parameter is YES, the generics or function name, if any, are included in the returned value. If NO, they are excluded. This parameter may not be null.

Returns:

If the tag's enclosing package name

• Has no characters: "OVERVIEW_SUMMARY"
• Non empty and its name
  • Has no characters: "PACKAGE_SUMMARY"
  • Non-empty: The name

getPackageDoc

public static final PackageDoc getPackageDoc(Tag tag)

Get the object containing the "package" of the tag-containing JavaDoc page.

This function was written by Stack Overflow user Chad Retz.

-

Returns:

If the tag's holder

• is a ProgramElementDoc: Its containing package.
• is a PackageDoc: tag.
• Otherwise: null

See Also:

https://chadretz.wordpress.com/2010/12/19/mathml-inside-javadoc-using-mathjax-and-a-custom-taglet/