| 1 |
779 |
jeremybenn |
/* Doclet.java -- Doclet API
|
| 2 |
|
|
Copyright (C) 1999 Free Software Foundation, Inc.
|
| 3 |
|
|
|
| 4 |
|
|
This file is part of GNU Classpath.
|
| 5 |
|
|
|
| 6 |
|
|
GNU Classpath is free software; you can redistribute it and/or modify
|
| 7 |
|
|
it under the terms of the GNU General Public License as published by
|
| 8 |
|
|
the Free Software Foundation; either version 2, or (at your option)
|
| 9 |
|
|
any later version.
|
| 10 |
|
|
|
| 11 |
|
|
GNU Classpath is distributed in the hope that it will be useful, but
|
| 12 |
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
| 13 |
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
| 14 |
|
|
General Public License for more details.
|
| 15 |
|
|
|
| 16 |
|
|
You should have received a copy of the GNU General Public License
|
| 17 |
|
|
along with GNU Classpath; see the file COPYING. If not, write to the
|
| 18 |
|
|
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
| 19 |
|
|
02110-1301 USA.
|
| 20 |
|
|
|
| 21 |
|
|
Linking this library statically or dynamically with other modules is
|
| 22 |
|
|
making a combined work based on this library. Thus, the terms and
|
| 23 |
|
|
conditions of the GNU General Public License cover the whole
|
| 24 |
|
|
combination.
|
| 25 |
|
|
|
| 26 |
|
|
As a special exception, the copyright holders of this library give you
|
| 27 |
|
|
permission to link this library with independent modules to produce an
|
| 28 |
|
|
executable, regardless of the license terms of these independent
|
| 29 |
|
|
modules, and to copy and distribute the resulting executable under
|
| 30 |
|
|
terms of your choice, provided that you also meet, for each linked
|
| 31 |
|
|
independent module, the terms and conditions of the license of that
|
| 32 |
|
|
module. An independent module is a module which is not derived from
|
| 33 |
|
|
or based on this library. If you modify this library, you may extend
|
| 34 |
|
|
this exception to your version of the library, but you are not
|
| 35 |
|
|
obligated to do so. If you do not wish to do so, delete this
|
| 36 |
|
|
exception statement from your version. */
|
| 37 |
|
|
|
| 38 |
|
|
|
| 39 |
|
|
package com.sun.javadoc;
|
| 40 |
|
|
|
| 41 |
|
|
/**
|
| 42 |
|
|
* This class documents the method that must be implemented by a doclet.
|
| 43 |
|
|
* It may be used as the superclass of a doclet, but this is not required.
|
| 44 |
|
|
* As long as the doclet implements the <code>start</code> method, all is ok.
|
| 45 |
|
|
*/
|
| 46 |
|
|
public abstract class Doclet
|
| 47 |
|
|
{
|
| 48 |
|
|
|
| 49 |
|
|
/**
|
| 50 |
|
|
* This is the entry point to a doclet. All doclets must implement this
|
| 51 |
|
|
* method.
|
| 52 |
|
|
*
|
| 53 |
|
|
* @param rd The <code>RootDoc</code> instance for this javadoc run.
|
| 54 |
|
|
*
|
| 55 |
|
|
* @return <code>true</code> on success, <code>false</code> on failure.
|
| 56 |
|
|
*/
|
| 57 |
|
|
public static boolean
|
| 58 |
|
|
start(RootDoc root)
|
| 59 |
|
|
{
|
| 60 |
|
|
return(false);
|
| 61 |
|
|
}
|
| 62 |
|
|
|
| 63 |
|
|
/*************************************************************************/
|
| 64 |
|
|
|
| 65 |
|
|
/**
|
| 66 |
|
|
* This method returns the number of arguments to the option, including
|
| 67 |
|
|
* the option itself. This is not required of doclets.
|
| 68 |
|
|
*
|
| 69 |
|
|
* @param opt The option to check.
|
| 70 |
|
|
*
|
| 71 |
|
|
* @return The number of arguments to the option, or zero if the option is
|
| 72 |
|
|
* unknown, or a negative number if an error occurred.
|
| 73 |
|
|
*/
|
| 74 |
|
|
public static int
|
| 75 |
|
|
optionLength(String opt)
|
| 76 |
|
|
{
|
| 77 |
|
|
return(0);
|
| 78 |
|
|
}
|
| 79 |
|
|
|
| 80 |
|
|
/*************************************************************************/
|
| 81 |
|
|
|
| 82 |
|
|
/**
|
| 83 |
|
|
* This method is called to verify that the options supplied by the caller
|
| 84 |
|
|
* are valid. This is not required of doclets.
|
| 85 |
|
|
*
|
| 86 |
|
|
* @param opts The list of options supplied by the user.
|
| 87 |
|
|
* @param logger A mechanism for this method to report errors to the user.
|
| 88 |
|
|
*
|
| 89 |
|
|
* @return <code>true</code> if the options are valid, <code>false</code>
|
| 90 |
|
|
* otherwise.
|
| 91 |
|
|
*/
|
| 92 |
|
|
public static boolean
|
| 93 |
|
|
validOptions(String[][] opts, DocErrorReporter logger)
|
| 94 |
|
|
{
|
| 95 |
|
|
return(true);
|
| 96 |
|
|
}
|
| 97 |
|
|
|
| 98 |
|
|
} // class Doclet
|
