public abstract class Doclet extends Object
start(RootDoc)
метод, как описано в описании пакета. Если doclet берет параметры командной строки, он должен также реализовать optionLength
и validOptions
. doclet поддерживающий функций языка, добавленных с тех пор 1.1 (таких как обобщения и аннотации), должен указать на это, реализовывая languageVersion
. В отсутствие этого doclet не должен вызвать ни один из методов API Doclet, добавленных с тех пор 1.5, и результаты нескольких других методов изменяются, чтобы скрыть новые конструкции (такие как параметры типа) от doclet.
Запустить doclet, передачу -doclet
сопровождаемый полностью определенным именем запускающегося class на javadoc командной строке инструмента.
Конструктор и Описание |
---|
Doclet() |
Модификатор и Тип | Метод и Описание |
---|---|
static LanguageVersion |
languageVersion()
Возвратите версию Языка программирования Java, поддерживаемого этим doclet.
|
static int |
optionLength(String option)
Проверьте на doclet-добавленные опции.
|
static boolean |
start(RootDoc root)
Генерируйте документацию здесь.
|
static boolean |
validOptions(String[][] options, DocErrorReporter reporter)
Проверьте, что у опций есть корректные параметры.
|
public static boolean start(RootDoc root)
public static int optionLength(String option)
Этот метод требуется, если doclet содержит какие-либо опции. Если этот метод будет отсутствовать, то Javadoc напечатает недопустимую ошибку флага для каждой опции.
public static boolean validOptions(String[][] options, DocErrorReporter reporter)
Этот метод не требуется, но рекомендуется, поскольку каждую опцию будут считать допустимой, если этот метод не будет присутствовать. Это примет значение по умолчанию корректно (к истине) если отсутствующий.
Параметр печати связанные сообщения об ошибках (использующий предоставленный DocErrorReporter) является ответственностью этого метода.
public static LanguageVersion languageVersion()
Этот метод требуется любым doclet поддержка версии языка, более новой чем 1.1.
Java является торговой маркой или зарегистрированной торговой маркой Oracle и/или его филиалов в US и других странах.
Авторское право © 1993, 2013, Oracle и/или его филиалы. 500 Бульваров Oracle
Берега красного дерева, Калифорния 94065 США. Все права защищены.
Проект сборка-b92