спецификации, руководства, описания, API

Стандартный Doclet

Содержание

Каков Стандартный Doclet
Выполнение Стандартного Doclet из Командной строки
Выполнение Стандартного Doclet Программно
Источник для Стандартного Doclet

Каков Стандартный Doclet

Стандарт doclet является doclet, обеспеченным Sun™, который производит значение по умолчанию Джейвэдока отформатированный HTML вывод API. Документация API для платформы Java™ в этой документации JDK является примером вывода стандартного doclet. Джейвэдок использует стандарт doclet, если никакой другой doclet не определяется, используя опцию -doclet Джейвэдока на командной строке.

Выполнение Стандартного Doclet из Командной строки

Стандарт doclet вызывается по умолчанию, когда никакой другой doclet не определяется с -doclet, наклеивают командную строку. Например, выполнение

% javadoc myPackage

будет использовать стандарт doclet, чтобы произвести документацию API HTML стиля по умолчанию для myPackage. Выполнение javadoc без опции -doclet эквивалентно выполнению javadoc использование опции -doclet, чтобы вызвать стандарт doclet. Таким образом, вышеупомянутая команда эквивалентна

% javadoc -docletpath /home/user/jdk1.5.0/lib/tools.jar \
  -doclet com.sun.tools.doclets.standard.Standard \
  myPackage

или

% javadoc -docletpath /home/user/jdk1.5.0/lib/tools.jar \
  -doclet com.sun.tools.doclets.formats.html.HtmlDoclet \
  myPackage

Оба из этих подходов эквивалентны.

Выполнение Стандартного Doclet Программно

У инструмента Javadoc есть программируемый интерфейс с открытыми методами для того, чтобы вызвать инструмент Javadoc из другой программы, записанной на языке Java. Эти методы располагаются в классе com.sun.tools.javadoc.Main в lib/tools.jar. Пример дается ниже.

Недостатки вызова main : (1) однажды Это можно только вызвать на выполненный - для 1.2.x или 1.3.x, использовать java.lang.Runtime.exec("javadoc ...") если больше чем один вызов необходим, (2) он выходит из использования System.exit(), который выходит из всей программы, и (3), код выхода не возвращается.

public static void main(java.lang.String[] args)

Интерфейс командной строки.
Параметры:: args - Параметры командной строки.

execute метод преодолевает все недостатки main.

public static int execute(java.lang.String[] args)

Программируемый интерфейс.
Параметры:: args - Параметры командной строки.
Возвраты:: Код возврата.

public static int execute(java.lang.String programName,
                          java.lang.String[] args)

Программируемый интерфейс.
Параметры:: programName - Имя программы (для сообщений об ошибках).; args - Параметры командной строки.
Возвраты:: Код возврата.

public static int execute(java.lang.String programName,
                          java.lang.String defaultDocletClassName,
                          java.lang.String[] args)

Программируемый интерфейс.
Параметры:: programName - Имя программы (для сообщений об ошибках).; defaultDocletClassName - Полностью определенное имя класса.; args - Параметры командной строки.
Возвраты:: Код возврата.

public static int execute(java.lang.String programName,
                          java.io.PrintWriter errWriter,
                          java.io.PrintWriter warnWriter,
                          java.io.PrintWriter noticeWriter,
                          java.lang.String defaultDocletClassName,
                          java.lang.String[] args)

Программируемый интерфейс.
Параметры:: programName - Имя программы (для сообщений об ошибках).; errWriter - PrintWriter, чтобы получить сообщения об ошибках.; warnWriter - PrintWriter, чтобы получить сообщения об ошибках.; noticeWriter - PrintWriter, чтобы получить сообщения об ошибках.; defaultDocletClassName - Полностью определенное имя класса.; args - Параметры командной строки.
Возвраты:: Код возврата.

Пример

С набором пути к классу к lib/tools.jar в Java SE передайте в каждой опции и параметре как отдельная строка:

com.sun.tools.javadoc.Main.execute(new String[] {"-d", "docs", "-sourcepath", "/home/usr/src", "p1", "p2"});

Источник для Стандартного Doclet

Можно загрузить исходный код для стандарта doclet как часть Java SE в:

Java Выпуск Исходного кода SE
(Отметьте: есть задержка между тем, когда JDK сначала доступен, и выпуск исходного кода доступен.)

Исходные файлы располагаются в каталоге src/share/classes/com/sun/tools/doclets.

Свяжитесь с Нами