Include constant String values in javadoc?

Question

I just got tired of search/replace in JavaDoc parts and asked myself if the following is possible:
(I use JSP Syntax for the part that I don't know if it's posible)
public static String insert = "this ist the insert";
* Display here: <%=insert%>
*/Any ideas!?

Answer 1

Was this {@value variable} feature ever implemented?
I really think is is a great idea and wish I could
use it.It has been added for 1.5. For 1.4 you can use this simple taglet:
import com.sun.tools.doclets.Taglet;
import com.sun.tools.doclets.standard.HtmlStandardWriter;
import com.sun.tools.doclets.standard.tags.AbstractInlineTaglet;
import com.sun.javadoc.*;
import java.util.Map;
public class MyValueTaglet extends AbstractInlineTaglet {
    private static final String NAME = "my.value";
     * Return the name of this custom tag.
    public String getName() {
        return NAME;
    public boolean inField() {
        return true;
    public boolean inConstructor() {
        return true;
    public boolean inMethod() {
        return true;
    public boolean inOverview() {
        return false;
    public boolean inPackage() {
        return false;
    public boolean inType() {
        return true;
    public boolean isInlineTag() {
        return true;
     * Register this Taglet.
     * @param tagletMap   the map to register this tag to.
    public static void register(Map tagletMap) {
       MyValueTaglet tag = new MyValueTaglet();
       tagletMap.put(tag.getName(), tag);
    public String toString(Tag tag, Doc doc, HtmlStandardWriter hsw) {
        ClassDoc lookup = null;
        if ( doc instanceof ClassDoc )
            lookup = (ClassDoc)doc;
        else if ( doc instanceof MemberDoc )
            lookup = ((MemberDoc)doc).containingClass();
        if ( lookup == null )
            return "";
        final String fieldName = tag.text();
        final FieldDoc[] fields = lookup.fields();
        for (int i = 0; i < fields.length; ++i)
            if ( fieldName.equals( fields.name() ) )
final Object value = fields[i].constantValue();
return (value != null) ? value.toString() : "";
return "";
Note:
In order to get this to work project wide, you need to have full qualified names as tag text and use the RootDoc to locate the appropriate packages and classes.