• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/com/sun/javadoc/Doclet.java@959103a6100f (annotated)

src/share/classes/com/sun/javadoc/Doclet.java

Wed, 27 Apr 2016 01:34:52 +0800

author

aoqi

date

Wed, 27 Apr 2016 01:34:52 +0800

changeset 0

959103a6100f

child 2525

2eb010b6cb22

permissions

-rw-r--r--

Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/langtools/
changeset: 2573:53ca196be1ae
tag: jdk8u25-b17

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1997, 2003, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.javadoc;
aoqi@0	27
aoqi@0	28	/**
aoqi@0	29	* This is an example of a starting class for a doclet,
aoqi@0	30	* showing the entry-point methods. A starting class must
aoqi@0	31	* import com.sun.javadoc.* and implement the
aoqi@0	32	* <code>start(RootDoc)</code> method, as described in the
aoqi@0	33	* <a href="package-summary.html#package_description">package
aoqi@0	34	* description</a>. If the doclet takes command line options,
aoqi@0	35	* it must also implement <code>optionLength</code> and
aoqi@0	36	* <code>validOptions</code>.
aoqi@0	37	*
aoqi@0	38	* <p> A doclet supporting the language features added since 1.1
aoqi@0	39	* (such as generics and annotations) should indicate this
aoqi@0	40	* by implementing <code>languageVersion</code>. In the absence of
aoqi@0	41	* this the doclet should not invoke any of the Doclet API methods
aoqi@0	42	* added since 1.5, and
aoqi@0	43	* the results of several other methods are modified so as
aoqi@0	44	* to conceal the new constructs (such as type parameters) from
aoqi@0	45	* the doclet.
aoqi@0	46	*
aoqi@0	47	* <p> To start the doclet, pass
aoqi@0	48	* <code>-doclet</code> followed by the fully-qualified
aoqi@0	49	* name of the starting class on the javadoc tool command line.
aoqi@0	50	*/
aoqi@0	51	public abstract class Doclet {
aoqi@0	52
aoqi@0	53	/**
aoqi@0	54	* Generate documentation here.
aoqi@0	55	* This method is required for all doclets.
aoqi@0	56	*
aoqi@0	57	* @return true on success.
aoqi@0	58	*/
aoqi@0	59	public static boolean start(RootDoc root) {
aoqi@0	60	return true;
aoqi@0	61	}
aoqi@0	62
aoqi@0	63	/**
aoqi@0	64	* Check for doclet-added options. Returns the number of
aoqi@0	65	* arguments you must specify on the command line for the
aoqi@0	66	* given option. For example, "-d docs" would return 2.
aoqi@0	67	* <P>
aoqi@0	68	* This method is required if the doclet contains any options.
aoqi@0	69	* If this method is missing, Javadoc will print an invalid flag
aoqi@0	70	* error for every option.
aoqi@0	71	*
aoqi@0	72	* @return number of arguments on the command line for an option
aoqi@0	73	* including the option name itself. Zero return means
aoqi@0	74	* option not known. Negative value means error occurred.
aoqi@0	75	*/
aoqi@0	76	public static int optionLength(String option) {
aoqi@0	77	return 0; // default is option unknown
aoqi@0	78	}
aoqi@0	79
aoqi@0	80	/**
aoqi@0	81	* Check that options have the correct arguments.
aoqi@0	82	* <P>
aoqi@0	83	* This method is not required, but is recommended,
aoqi@0	84	* as every option will be considered valid if this method
aoqi@0	85	* is not present. It will default gracefully (to true)
aoqi@0	86	* if absent.
aoqi@0	87	* <P>
aoqi@0	88	* Printing option related error messages (using the provided
aoqi@0	89	* DocErrorReporter) is the responsibility of this method.
aoqi@0	90	*
aoqi@0	91	* @return true if the options are valid.
aoqi@0	92	*/
aoqi@0	93	public static boolean validOptions(String options[][],
aoqi@0	94	DocErrorReporter reporter) {
aoqi@0	95	return true; // default is options are valid
aoqi@0	96	}
aoqi@0	97
aoqi@0	98	/**
aoqi@0	99	* Return the version of the Java Programming Language supported
aoqi@0	100	* by this doclet.
aoqi@0	101	* <p>
aoqi@0	102	* This method is required by any doclet supporting a language version
aoqi@0	103	* newer than 1.1.
aoqi@0	104	*
aoqi@0	105	* @return the language version supported by this doclet.
aoqi@0	106	* @since 1.5
aoqi@0	107	*/
aoqi@0	108	public static LanguageVersion languageVersion() {
aoqi@0	109	return LanguageVersion.JAVA_1_1;
aoqi@0	110	}
aoqi@0	111	}