--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/share/classes/com/sun/javadoc/Doclet.java	Sat Dec 01 00:00:00 2007 +0000
@@ -0,0 +1,111 @@
+/*
+ * Copyright 1997-2003 Sun Microsystems, Inc.  All Rights Reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Sun designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Sun in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
+ * CA 95054 USA or visit www.sun.com if you need additional information or
+ * have any questions.
+ */
+
+package com.sun.javadoc;
+
+/**
+ * This is an example of a starting class for a doclet,
+ * showing the entry-point methods.  A starting class must
+ * import com.sun.javadoc.* and implement the
+ * <code>start(RootDoc)</code> method, as described in the
+ * <a href="package-summary.html#package_description">package
+ * description</a>.  If the doclet takes command line options,
+ * it must also implement <code>optionLength</code> and
+ * <code>validOptions</code>.
+ *
+ * <p> A doclet supporting the language features added since 1.1
+ * (such as generics and annotations) should indicate this
+ * by implementing <code>languageVersion</code>.  In the absence of
+ * this the doclet should not invoke any of the Doclet API methods
+ * added since 1.5, and
+ * the results of several other methods are modified so as
+ * to conceal the new constructs (such as type parameters) from
+ * the doclet.
+ *
+ * <p> To start the doclet, pass
+ * <code>-doclet</code> followed by the fully-qualified
+ * name of the starting class on the javadoc tool command line.
+ */
+public abstract class Doclet {
+
+    /**
+     * Generate documentation here.
+     * This method is required for all doclets.
+     *
+     * @return true on success.
+     */
+    public static boolean start(RootDoc root) {
+        return true;
+    }
+
+    /**
+     * Check for doclet-added options.  Returns the number of
+     * arguments you must specify on the command line for the
+     * given option.  For example, "-d docs" would return 2.
+     * <P>
+     * This method is required if the doclet contains any options.
+     * If this method is missing, Javadoc will print an invalid flag
+     * error for every option.
+     *
+     * @return number of arguments on the command line for an option
+     *         including the option name itself.  Zero return means
+     *         option not known.  Negative value means error occurred.
+     */
+    public static int optionLength(String option) {
+        return 0;  // default is option unknown
+    }
+
+    /**
+     * Check that options have the correct arguments.
+     * <P>
+     * This method is not required, but is recommended,
+     * as every option will be considered valid if this method
+     * is not present.  It will default gracefully (to true)
+     * if absent.
+     * <P>
+     * Printing option related error messages (using the provided
+     * DocErrorReporter) is the responsibility of this method.
+     *
+     * @return true if the options are valid.
+     */
+    public static boolean validOptions(String options[][],
+                                       DocErrorReporter reporter) {
+        return true;  // default is options are valid
+    }
+
+    /**
+     * Return the version of the Java Programming Language supported
+     * by this doclet.
+     * <p>
+     * This method is required by any doclet supporting a language version
+     * newer than 1.1.
+     *
+     * @return  the language version supported by this doclet.
+     * @since 1.5
+     */
+    public static LanguageVersion languageVersion() {
+        return LanguageVersion.JAVA_1_1;
+    }
+}