Spec-Zone .ru
спецификации, руководства, описания, API
|
% 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Оба из этих подходов эквивалентны.
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
- Полностью определенное имя class.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
- Полностью определенное имя class.args
- Параметры командной строки.Пример
С набором пути к классу к lib/tools.jar
в Java SE передайте в каждой опции и параметре как отдельная строка:
com.sun.tools.javadoc.Main.execute(new String[] {"-d", "docs", "-sourcepath", "/home/usr/src", "p1", "p2"});
src/share/classes/com/sun/tools/doclets
.