$B%I%C%/%l%C%H$N35MW(J

% javadoc -doclet ListClass -classpath C:\jdk1.3\lib\tools.jar MyClass.java

$B%3%^%s%I9T%*%W%7%g%s$K$D$$$F$NCm(J: javadoc-help $B$rl9g$K$OMxMQ$G$-$^$;$s!#(J $B%+%9%?%`%I%C%/%l%C%H$G$O!"%I%C%/%l%C%HFH<+$N%3%^%s%I9T%*%W%7%g%s$rDj5A$9$k$3$H$b$G$-$^$9!#(J $B$3$N$"$H$N(J$BNc(J$B$r;2>H$7$F$/$@$5$$!#(J

API $B%I%-%e%a%s%H$r@8@.$9$k$K$O!"%I%C%/%l%C%H$O!"$3$N4JC1$JNc$h$j$b$+$J$jJ#;($K$J$j$^$9!#(J javadoc $B$G@8@.$9$k(J API $B%I%-%e%a%s%H$N7A<0$r%+%9%?%^%$%:$9$k>l9g$O!"%I%C%/%l%C%H$r<+J,$G%<%m$+$i:n@.$9$k$h$j$b!"%G%U%)%k%H$NI8=`%I%C%/%l%C%H$K=$@5$r2C$($k7A$G:n@.$7$?J}$,4JC1$G$9!#(J

$BNc(J $BK
I8=`%I%C%/%l%C%H$N%5%V%/%i%92=(J

$BHow can I modify the standard doclet to produce links to source code from the API documentation?$B!W$r;2>H$7$F$/$@$5$$!#(J $B4V0c$$$r8+$D$1$?>l9g$O!"(Jjavadoc-tool@sun.com $B$^$G$*CN$i$;$/$@$5$$!#(J

$BNc(J - $B%+%9%?%`%?%0$N:n@.$H=hM}(J

method.tags("mytag")

@mytag Some dummy text.

$B

import com.sun.javadoc.*;

public class ListTags {
    public static boolean start(RootDoc root){
        String tagName = "mytag";
        writeContents(root.classes(), tagName);
        return true;
    }

    private static void writeContents(ClassDoc[] classes, String tagName) {
        for (int i=0; i
< classes.length; i++) {
            boolean classNamePrinted = false;
            MethodDoc[] methods = classes[i].methods();
            for (int j=0; j < methods.length; j++) {
                Tag[] tags = methods[j].tags(tagName);
                if (tags.length > 0) {
                    if (!classNamePrinted) {
                        System.out.println("\n" + classes[i].name() + "\n");
                        classNamePrinted = true;
                    }
                    System.out.println(methods[j].name());
                    for (int k=0; k
< tags.length; k++) {
                        System.out.println("   " + tags[k].name() + ": "
                            + tags[k].text());
                    }
                }
            }
        }
    }
}

$B%+%9%?%`%*%W%7%g%s$r;HMQ$9$k%I%C%/%l%C%H$O!"(J int $B$rJV$9(J optionLength(String $B%*%W%7%g%s(J) $B$H$$$&%a%=%C%I$r$b$C$F$$$kI,MW$,$"$j$^$9!#(J $B%I%C%/%l%C%H$KG'<1$5$;$k3F%+%9%?%`%*%W%7%g%s$K!"(J optionLength $B$,$=$N%*%W%7%g%s$r9=@.$9$kMWAG(J ($B%H!<%/%s(J) $B$N?t$r(J $BJV$5$J$1$l$P$J$j$^$;$s!#(J $B$3$3$G$O!"(J -tag mytag $B$H$$$&7A<0$N%+%9%?%`%*%W%7%g%s$r;HMQ$G$-$k$h$&$K$7$F$_$^$9!#(J $B$3$N%+%9%?%`%*%W%7%g%s$G$O!"(J -tag $B%*%W%7%g%s$=$N$b$N$H$=$NCM$N(J 2 $B$D$NMWAG$G9=@.$5$l$k$N$G!":n@.$9$k%I%C%/%l%C%H$N(J optionLength$B%a%=%C%I$O!"(J -tag $B%*%W%7%g%s$KBP$7$F(J 2 $B$rJV$5$J$/$F$O$J$j$^$;$s!#(J $B$^$?!"G'<1$G$-$J$$%*%W%7%g%s$KBP$7$F$O!"(J0 $B$rJV$7$^$9!#(J

$B3HD%$r;\$7$?%I%C%/%l%C%H$N40A4$J%3!<%I$r

import com.sun.javadoc.*;

public class ListTags {
    public static boolean start(RootDoc root){
        String tagName = readOptions(root.options());
        writeContents(root.classes(), tagName);
        return true;
    }

    private static void writeContents(ClassDoc[] classes, String tagName) {
        for (int i=0; i
< classes.length; i++) {
            boolean classNamePrinted = false;
            MethodDoc[] methods = classes[i].methods();
            for (int j=0; j < methods.length; j++) {
	        Tag[] tags = methods[j].tags(tagName);
	        if (tags.length > 0) {
	            if (!classNamePrinted) {
	                System.out.println("\n" + classes[i].name() + "\n");
	                classNamePrinted = true;
	            }
	            System.out.println(methods[j].name());
	            for (int k=0; k
< tags.length; k++) {
	                System.out.println("   " + tags[k].name() + ": " + tags[k].text());
	            }
	        }
	    }
        }
    }

    private static String readOptions(String[][] options) {
        String tagName = null;
        for (int i = 0; i < options.length; i++) {
            String[] opt = options[i];
	    if (opt[0].equals("-tag")) {
	        tagName = opt[1];
	    }
        }
	return tagName;
    }

    public static int optionLength(String option) {
        if(option.equals("-tag")) {
	    return 2;
        }
        return 0;
    }

    public static boolean validOptions(String options[][],
				       DocErrorReporter reporter) {
	boolean foundTagOption = false;
        for (int i = 0; i
< options.length; i++) {
            String[] opt = options[i];
            if (opt[0].equals("-tag")) {
	        if (foundTagOption) {
	            reporter.printError("Only one -tag option allowed.");
		    return false;
	        } else {
		    foundTagOption = true;
		}
	    }
	}
	if (!foundTagOption) {
	    reporter.printError("Usage: javadoc -tag mytag -doclet ListTags ...");
	}
	return foundTagOption;
    }
}

$B$5$i$K!"$3$N%I%C%/%l%C%H$K$O!"%3%^%s%I9T%*%W%7%g%s$r2r@O$7$F(J -tag $B%*%W%7%g%s$rC5$9(J readOptions $B%a%=%C%I$bDI2C$5$l$F$$$^$9!#(J $B$3$N%a%=%C%I$G$O!"(J use of the fact that the $B%*%W%7%g%s$N>pJs$,4^$^$l$?(J String $B7?$N(J 2 $BRootdoc.options $B%a%=%C%I$rMxMQ$7$F$$$^$9!#(J information. $B$?$H$($P!"

javadoc -foo this that -bar other ...

options()[0][0] = "-foo"
options()[0][1] = "this"
options()[0][2] = "that"
options()[1][0] = "-bar"
options()[1][1] = "other"

validOptions $B%a%=%C%I$O!"%3%^%s%I9T%?%0$N;XDj$,@5$7$$$+$I$&$+$r%A%'%C%/$9$k$?$a$N!">JN,2DG=$J%a%=%C%I$G$9!#(J validOptions $B%a%=%C%I$O!"B8:_$9$l$P<+F0E*$K8F$S=P$5$l$k$?$a!"L@<(E*$K8F$S=P$9I,MW$O$"$j$^$;$s!#(J $B$3$N%a%=%C%I$G$O!"%*%W%7%g%s$N;XDj$,@5$7$$>l9g$O(J true $B$rJV$7!"$=$&$G$J$$>l9g$O(J false $B$rJV$9$h$&$K$7$^$9!#(J $B$^$?!";XDj$N@5$7$/$J$$%3%^%s%I9T%*%W%7%g%s$,8+$D$+$C$?>l9g$K!"(JvalidOptions $B$+$iE,@Z$J%(%i!<%a%C%;!<%8$rI=<($9$k$3$H$b$G$-$^$9!#(J $B$3$N%I%C%/%l%C%H$N(J validOptions $B%a%=%C%I$G$O!"(J-tag $B%*%W%7%g%s$,(J 1 $B$D;XDj$5$l$F$$$k$+$I$&$+!"$=$7$F(J 2 $B$D0J>e;XDj$5$l$F$$$J$$$+$I$&$+$r%A%'%C%/$7$F$$$^$9!#(J

Copyright © 1995-98 Sun Microsystems, Inc. All Rights Reserved. $B%3%a%s%H$NAwIU@h(J: javadoc-tool@sun.com