Trying to understand JavaDoc and custom Doclets

Posted on 2006-04-19
Medium Priority
Last Modified: 2006-11-18
Hi I've been trying to understand how JavaDocs and Custom doclets work. I want to create a doclet that will only display methods which has a custom tag, i.e. if a method has @myTag in the comments it'll display all the comments for that method whereas if it doesn't have @myTag it doesn't show any oof the comments

I created a custom taglet and specify the following command in Eclipse:
           -taglet DocPackage.myTag -tagletpath 'C:\\Documents and Settings\\bbermingham\\workspace\\JavaDocTest'

But I want it to output in the standard html format. I think I'll have to completly create a new Doclet which has all the code for creating the html files, css files, etc because the Standard doc really can't be modified (I found). I'm very new to this and really I'm just looking for steps to create this custom doclet. What classes do I need to refer to, do I need to implement another class or extend from Doclet or Standard?

I hope I'm making sense.
Question by:rebels_mascot
LVL 11

Accepted Solution

WelkinMaze earned 250 total points
ID: 16487554
Here you can find some info:

And here is a part from it:
Example - Subclassing the Standard Doclet
To customize the output of the Javadoc tool, you need to write your own doclet that specifies the content and format of the output that you desire. If you want HTML output with roughly the same format as the default output, you can use the standard doclet as a starting point for creating your doclet. You can subclass appropriate classes in the standard doclet and then add or override methods as necessary to produce the output you want. Or you can copy the whole standard doclet and modify it. If you use a copy of the standard doclet as your starting point, you may want to remove the package statements at the beginning of each source file and replace them with the name of your own, new package.

Author Comment

ID: 16487765
Thanks for the quick reply WelkinMaze, I've come across that before but not sure how to change the methods they refer to. The Standard.java file is as follows:

 * @(#)Standard.java      1.4 04/07/26
 * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
 * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.

package com.sun.tools.doclets.standard;

import com.sun.javadoc.*;
import com.sun.tools.doclets.formats.html.*;

public class Standard {
    public static final HtmlDoclet htmlDoclet = new HtmlDoclet();
    public static int optionLength(String option) {
        return htmlDoclet.optionLength(option);
    public static boolean start(RootDoc root) {
        return htmlDoclet.start(root);
    public static boolean validOptions(String[][] options,
                                   DocErrorReporter reporter) {
        return htmlDoclet.validOptions(options, reporter);

    public static LanguageVersion languageVersion() {
      return htmlDoclet.languageVersion();

I can't see how I can change this to only output methods with the @myTag taglet.

Featured Post

Concerto's Cloud Advisory Services

Want to avoid the missteps to gaining all the benefits of the cloud? Learn more about the different assessment options from our Cloud Advisory team.

Question has a verified solution.

If you are experiencing a similar issue, please ask a related question

INTRODUCTION Working with files is a moderately common task in Java.  For most projects hard coding the file names, using parameters in configuration files, or using command-line arguments is sufficient.   However, when your application has vi…
By the end of 1980s, object oriented programming using languages like C++, Simula69 and ObjectPascal gained momentum. It looked like programmers finally found the perfect language. C++ successfully combined the object oriented principles of Simula w…
This tutorial covers a step-by-step guide to install VisualVM launcher in eclipse.
How to fix incompatible JVM issue while installing Eclipse While installing Eclipse in windows, got one error like above and unable to proceed with the installation. This video describes how to successfully install Eclipse. How to solve incompa…
Suggested Courses
Course of the Month15 days, 23 hours left to enroll

850 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question