org.tullmann.taglets
Class ReviewedBy

java.lang.Object
  |
  +--org.tullmann.taglets.ListTag
        |
        +--org.tullmann.taglets.ReviewedBy

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

Direct Known Subclasses:

JSR121ReviewedBy, PatsReviewedBy

public class ReviewedBy

extends ListTag

A Taglet that defines the @reviewedby tag for Javadoc comments. The ReviewedBy taglet is customizable and handles multiple entries cleanly.

Usage

 	@reviewedby <name> <date> [notes ...]
 

Indicate a code review for the associated class/interface was completed by a reviewer. name is a unique name for a reviewer (for example, an appropriate login name). The date is a YYYY/MM/DD style date string. Each must be a single token. Any [notes ...] are optional.

@reviewedby is only recognized on class/interface level comments.

HTML in the generated javadoc can include provided reviews, missing reviews, or both. For provided reviews, a full or compact format is supported.

The set of expected IDs and due dates are set via JDK1.4 java.util.prefs preferences. See below for a description of the preferences.

See the generated javadoc below for an example of what this might look like.

Customization

Customized via java.util.prefs. You'll need a prefs editor, or a clue about how and where user prefs are stored.

Main node is org.tullmann.taglets.reviewedby:

• projectname: Name of the project. The only way to set this is to subclass ReviewedBy and override register(java.util.Map). See PatsReviewedBy.
  • header.{color.bg,color.fg,relsize}: Customize formating for the section header.
  • header.text: Text to go in the section header (Defaults to 'Reviewed By:')
  • review.uids: Comma-delimited list of ids associated with this project. Allows a list of "missing" reviews to be generated.
  • review.date.format: Date format used for @reviewedby (anything that SimpleDateFormat can use).
  • show.completed: Include completed reviews in generated HTML. On by default.
  • show.completed.since: Only include reviews completed since given date. Handy for requiring another round of reviews. Not set by default.
  • show.missing: Show missing reviews. On by default.
  • text.{color.fg,color.bg,relsize}: Control formatting of review entries in table.
  • html.date.format: SimpleDateFormat string for generated HTML dates.
  • perfile.filename.: (NOT IMPLEMENTED)
    • expectedIDs:
    • duedate:

See PrefHack for a simple mechanism to set these preferences.

Using with Javadoc

Run javadoc with a -tagletpath that points to the compiled version of this class (and its dependents) and pass -taglet org.tullmann.taglets.ReviewedBy to javadoc. That will cause the @reviewedby tag to be registered.

To Do:

• Implement customization

Reviewed By:

User	Date	Comment
tullmann	March 31, 2002
bubbles	March 1, 2002	Woo!

Missing Reviews:

wall, torvalds, guido, pike

Since:

March, 2002

Author:

Patrick Tullmann <taglets@tullmann.org>

Field Summary

Fields inherited from class org.tullmann.taglets.ListTag

ORDERED_LIST, TABLE_LIST, tagPrefs, UNORDERED_LIST, VISIBLETABLE_LIST

Constructor Summary

ReviewedBy()

ReviewedBy(java.lang.String projectName)
Create a new ListTag, with tag name 'reviewedby'.

Method Summary

protected void	emitCustomFooter(java.lang.StringBuffer sbuf, boolean multi) Override
protected void	emitCustomHeader(java.lang.StringBuffer sbuf, boolean multi) Override
protected void	endingTags(java.lang.StringBuffer sbuf)
protected void	forceCustomDefaultPrefs(org.tullmann.taglets.TagPrefs tagPrefs)
boolean	inConstructor()
boolean	inField()
boolean	inMethod()
boolean	inOverview()
boolean	inPackage()
boolean	inType()
boolean	isInlineTag()
protected void	parseTagText(java.lang.StringBuffer sbuf, java.lang.String text, boolean multi) Override parsing of tag text to pull out table stuff.
static void	register(java.util.Map tagletMap)
protected void	startingTags()

Methods inherited from class org.tullmann.taglets.ListTag

emitFooter, emitHeader, emitTag, forceColorPrefs, formatText, getName, register, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ReviewedBy

public ReviewedBy()

ReviewedBy

public ReviewedBy(java.lang.String projectName)

Create a new ListTag, with tag name 'reviewedby'. Default the tag header to 'Reviewed By:' and default to an unordered list.

Method Detail

register

public static void register(java.util.Map tagletMap)

startingTags

protected void startingTags()

Overrides:

startingTags in class ListTag

endingTags

protected void endingTags(java.lang.StringBuffer sbuf)

Overrides:

endingTags in class ListTag

forceCustomDefaultPrefs

protected void forceCustomDefaultPrefs(org.tullmann.taglets.TagPrefs tagPrefs)

Overrides:

forceCustomDefaultPrefs in class ListTag

emitCustomHeader

protected void emitCustomHeader(java.lang.StringBuffer sbuf,
                                boolean multi)

Override

Overrides:

emitCustomHeader in class ListTag

emitCustomFooter

protected void emitCustomFooter(java.lang.StringBuffer sbuf,
                                boolean multi)

Override

Overrides:

emitCustomFooter in class ListTag

parseTagText

protected void parseTagText(java.lang.StringBuffer sbuf,
                            java.lang.String text,
                            boolean multi)

Override parsing of tag text to pull out table stuff.

Overrides:

parseTagText in class ListTag

Returns:

the given StringBuffer.

isInlineTag

public boolean isInlineTag()

Specified by:

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

Overrides:

isInlineTag in class ListTag

inField

public boolean inField()

Specified by:

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

Overrides:

inField in class ListTag

inConstructor

public boolean inConstructor()

Specified by:

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

Overrides:

inConstructor in class ListTag

inMethod

public boolean inMethod()

Specified by:

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

Overrides:

inMethod in class ListTag

inType

public boolean inType()

Specified by:

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

Overrides:

inType in class ListTag

inPackage

public boolean inPackage()

Specified by:

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

Overrides:

inPackage in class ListTag

inOverview

public boolean inOverview()

Specified by:

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

Overrides:

inOverview in class ListTag