gjdoc-4.8 - Інтернет у хмарі

ПРОГРАМА:

ІМ'Я

cp-tools - Посібник із інструментів GNU Classpath

СИНТАКСИС

gjdoc [- вихідний шлях список шляхів]
[-всі] [-субпакети упак.: упк:...] [- виключити pkglist]
[-кодування набір] [- локаль ім'я] [-Source звільнити]
[-публічний] [-захищений] [- пакет] [-приват]
[-докт текст] [- заголовок текст] [-нижній колонтитул текст] [-низу текст]
[-посилання URL] [-посилання в автономному режимі URL шлях] [-некваліфікатор упак.: упк:...]
[- tagletpath список шляхів] [- таглет className] [-таг tagspec]
[-використовувати] [- джерело посилання] [-індекс розщеплення] [-noindex] [-нодерево]
[-версія] [-автор] [- нескінченно] [-додати таблицю стилів файл]
[-d targetdir]
[пакети...] [вихідні файли...] [@cmd-файл]

gjdoc [- вихідний шлях список шляхів]
[-всі] [-субпакети упак.: упк:...] [- виключити pkglist]
[-кодування набір] [- локаль ім'я] [-Source звільнити]
[-публічний] [-захищений] [- пакет] [-приват]
[-docletpath список шляхів] [- доклет className]
[пакети...] [вихідні файли...] [@cmd-файл]
[параметри doclet]

gjdoc --допомога

gjdoc -- версія

Тут наведено лише найбільш корисні параметри; решту дивіться нижче.

ОПИС

Gjdoc можна використовувати двома способами: як окремий інструмент документації або як драйвер для a
визначений користувачем Doclet.

У режимі за замовчуванням Gjdoc використовуватиме стандартний Doclet HtmlDoclet для створення набору
HTML-сторінки. Канонічне використання таке:

gjdoc -s src/java/ -all -d api-docs/

Тут, src/java/ є коренем ієрархії класів вихідного коду, -всі означає, що все вірно
Файли Java, знайдені в цьому кореневому каталозі, мають бути оброблені, і api-docs/ є
каталог, куди потрібно розмістити створену документацію.

Щоб дізнатися більше про запуск Doclets, крім стандартного Doclet, зверніться до посібника.

ВАРІАНТИ

варіант Підсумки by тип

Ось підсумок усіх варіантів Gjdoc і Standard Doclet, згрупованих за
типу. Пояснення наведено в наступних розділах.

Source Установка Опції
- вихідний шлях список шляхів -субпакети pkglist - виключити pkglist

Source сформований Опції
-Source звільнити -кодування кодування - брекератор

Взаємозв'язок Опції
-посилання URL -посилання в автономному режимі URL файл -некваліфікатор упак.: упк:...

Покоління Опції
-автор - текст ліцензії -використовувати -версія -індекс розщеплення -noindex
-не рекомендований вузол -nodeprecatedlist -недопомога -нонавбар
- нескінченно -нодерево -публічний -захищений - пакет -приват
-docfilessubdirs -excludedocfillesssubdir прізвище
- джерело посилання

Вихід Опції
-d - локаль ім'я -набір символів набір -доценкодування набір
-дійсний html -baseurl URL

Прикраса Опції
-заголовок вікна текст -докт текст -заголовок текст
- заголовок текст -нижній колонтитул текст -низу текст
- файл довідки файл -файл таблиці стилів файл -додати таблицю стилів файл
-група заголовок групи pkgpattern:pkgpattern:...

Taglet Опції
- tagletpath - таглет назви класу -таг tagspec

Доклет Опції
-docletpath - доклет назви класу

Багатослівність Опції
-спокійно -вербозний

Віртуальний машина Опції
-класний шлях -bootclasspath -J vmopt

вибирає який Source Файли до Процес

-s список шляхів
- вихідний шлях список шляхів
Шукайте вихідні файли у вказаному каталозі або каталогах.

список шляхів має бути один або кілька шляхів до каталогу, розділених шляхом вашої платформи
роздільник (зазвичай : or ;).

Якщо ця опція не надається, gjdoc шукатиме вихідні файли в поточному
каталог.

Вказані каталоги мають бути кореневими каталогами з точки зору пакета Java
системи. Наприклад, якщо ви хочете створити документацію для класів у пакеті
foo.bar, ви повинні вказати каталог, що містить файл верхнього рівня Foo підкаталог,
не каталог foo/бар/ в якому знаходяться вихідні файли Java.

Скорочений псевдонім -s специфічно для gjdoc і несумісний із Sun javadoc.

-всі
[ЕКСПЕРИМЕНТАЛЬНИЙ] Обробити всі дійсні вихідні файли Java, знайдені в каталогах, перерахованих у
вихідний шлях та їхні підкаталоги.

Це спеціальний варіант gjdoc і несумісний із Sun javadoc.

-субпакети упак.: упк:...
Рекурсивно обробляйте класи в наданих пакетах Java та всіх підпакетах.
Зауважте, що кілька назв пакетів мають бути розділені двокрапками замість пробілів.

- виключити упак.: упк:...
Не обробляйте класи в даних пакетах Java і всіх підпакетах рекурсивно.
Цей параметр можна використовувати разом із -всі or -субпакети щоб виключити
окремі пакети або піддерева пакетів з виходу.

пакети...
Обробити всі класи в наданих пакетах Java.

вихідні файли...
Обробіть класи у наданих вихідних файлах Java.

Уточнення сформований of вхід Файли

-Source звільнити
Припустимо, що вихідні файли призначені для даного випуску платформи Java.

звільнити має бути номером версії випуску платформи Java у форматі
МАЖОР.НЕЗНАЧНИЙ, наприклад 1.4.

Цей параметр наразі ігнорується, за винятком того, що виникає помилка, якщо номер випуску
окрім 1.2, 1.3 or 1.4 вказано.

-кодування набір
Припустимо, що вихідні файли закодовані за допомогою набір.

Приклади для набір він має США-ASCII, ISO-8859-1 or UTF-8.

Семантика набір є ідентичними тим з
java.nio.charset.Charset.forName(рядок).

- брекератор
Використовуйте java.text.BreakIterator локалі замість внутрішнього першого речення
детектор.

За замовчуванням gjdoc використовує внутрішній алгоритм, щоб визначити, де закінчується речення. Коли
ця опція надається, замість цього використовуватиметься java.text.BreakIterator екземпляр для
місцевий стандарт, заданий з - локаль (або локаль за замовчуванням).

Цю опцію необхідно вказати під час звернення gjdoc до вихідного коду, прокоментованого в не-
латинська мова, для якої не працює детектор першого речення за замовчуванням. Для усіх
В інших випадках за замовчуванням (не використовуйте BreakIterator) дає кращі результати в
час написання цього тексту.

Взаємозв'язок з інший документація набори

-посилання URL
Створіть гіперпосилання на інший набір документів.

За замовчуванням gjdoc створюватиме лише гіперпосилання на класи у вихідному наборі. Використовуй це
можливість додаткового створення гіперпосилань на класи, охоплені зазначеним
комплект документації.

URL має бути кореневою URL-адресою іншого набору документації. Наприклад, додати
гіперпосилання на GNU Classpath, вкажіть наступне:

-посилання http://developer.classpath.org/doc/

Команда -посилання опцію можна вказати кілька разів.

Зауважте, що вказавши -посилання Опція спричиняє доступ HTTP щоразу, коли gjdoc
викликаний. Ви можете використовувати -посилання в автономному режимі замість цього, щоб уникнути цього доступу.

-посилання в автономному режимі URL файл
Створіть гіперпосилання на інший набір документації, який також присутній у локальному файлі
системи.

Цей варіант працює точно так само -посилання, за винятком того, що він звертається до локальної файлової системи
замість мережі для визначення, які класи охоплені пов’язаними
комплект документації.

При використанні -посилання в автономному режимі доступ до набору віддаленої документації взагалі не здійснюється, що може
значно прискорює час генерації залежно від вашого мережевого підключення. The
створені гіперпосилання на набір документації, однак, посилаються на віддалений набір, а не на
локальний, щоб ви могли розповсюджувати документацію без зайвих зусиль
залежності.

Команда -посилання в автономному режимі опцію можна вказати кілька разів.

-некваліфікатор упак.: упк:...
Не кваліфікуйте назви класів у наданих пакунках їх іменами пакетів.

За замовчуванням ім’я класу відображається без кваліфікації, лише якщо клас є частиною
вихідний набір або пов’язаний набір документації та кваліфікований з назвою його
містить пакет, якщо це не так. Ви можете використовувати цю опцію, щоб примусово вводити некваліфіковані імена
для класів, навіть якщо вони не є частиною набору документації.

Наприклад, зазвичай посилання на клас String представляється повністю уточненим як
java.lang.String (якщо не посилатися на відповідний набір документації за допомогою -посилання)
оскільки це не є частиною набору документації. Ви можете вказати -некваліфікатор
java.lang щоб відображати ті самі посилання, як рядок.

Зауважте, що для всіх некваліфікованих імен класів підказка надається, коли ви розміщуєте свій
наведіть на нього вказівник миші в документації HTML.

-некваліфікатор всі
Пропустіть кваліфікатор назви пакета з усіх імен класів.

Вкажіть цей параметр, щоб взагалі пропустити кваліфікатори назви пакетів,

вибирає який Інформація до Генерувати

-публічний
Включіть у вихідні дані лише публічних членів відкритих класів. За замовчуванням захищено
члени класу також включені.

-захищений
Включіть публічні або захищені члени відкритих класів у вихідні дані. Це
за замовчуванням.

- пакет
Включіть публічних, захищених і пакетно-приватних членів публічних і пакетно-приватних
класи.

-приват
Включіть усі класи та членів класу незалежно від рівня їх доступу.

-індекс розщеплення
Створіть одну індексну сторінку на лист замість однієї монолітної сторінки індексу.

За замовчуванням індекс, створений за допомогою Standard Doclet, містить усі записи в одному
сторінка. Це добре для невеликих наборів документації, але для великих наборів ви повинні
вкажіть цей параметр.

- нескінченно
Ігнорувати @з тих пір теги в коментарях javadoc.

За замовчуванням згенерований вихід містить розділи з переліком версії вашого API
з якого пакет, клас або член класу існує, коли цей тег є
зіткнувся. Вкажіть цей параметр, щоб пропустити цю інформацію.

-нодерево
Не створюйте жодних сторінок дерева.

За замовчуванням згенерований вихід містить одне дерево успадкування на пакет і - if
набір документації складається з кількох пакетів - сторінки з повним успадкуванням
дерево. Вкажіть цей параметр, щоб пропустити створення цих сторінок.

-noindex
Не виводьте алфавітний покажчик.

За замовчуванням gjdoc генерує алфавітний індекс усіх елементів програми в
набір документації (пакети, класи, внутрішні класи, конструктори, методи та
поля). Вкажіть цей параметр, щоб пропустити цю інформацію.

-недопомога
Не створюйте сторінку довідки.

Наразі цей параметр ігнорується, оскільки стандартний Doclet не містить сторінки довідки.

-не рекомендований вузол
Не виводьте вбудовану інформацію про застарілі пакунки, класи чи члени класу.

За замовчуванням стандартний Doclet додає виділений абзац із забороною
інформацію до опису кожного застарілого елемента програми. Вкажіть це
можливість пропустити цю інформацію.

-nodeprecatedlist
Не виводьте підсумкову сторінку для застарілих елементів API.

За замовчуванням стандартний Doclet створює сторінку зі списком усіх застарілих елементів API
разом із описом припинення підтримки, який зазвичай містить причину припинення підтримки
та можливі альтернативи. Вкажіть цей параметр, щоб пропустити цю інформацію.

-нонавбар
Не виводьте панель навігації, верхній і нижній колонтитул.

За замовчуванням кожна вихідна сторінка оснащена верхньою панеллю навігації (яка може включати
визначений користувачем заголовок) і нижню панель навігації (яка може включати в себе
вказаний нижній колонтитул). Вкажіть цей параметр, щоб пропустити цю прикрасу.

-без коментарів
Пропустіть весь текст документації зі згенерованих файлів і виведіть лише оголошення та
зв'язки між елементами програми.

Цей параметр тут для сумісності з javadoc. Якщо ви плануєте видобувати
інформацію про ваш проект через gjdoc, вам слід розглянути можливість використання іншого Doclet
замість цього для ваших цілей, наприклад XmlDoclet. Ви також можете використовувати Doclet API
безпосередньо шляхом впровадження нового Doclet.

- джерело посилання
Згенеруйте сторінку з виділеним синтаксисом вихідним кодом для кожного класу. За замовчуванням це
сторінка не створюється.

Доступ до вихідного коду можна отримати, натиснувши кнопку з написом «Джерело».
на навігаційній панелі, або клацнувши назву конструктора, поля, методу чи внутрішньої
class у розділі деталей сторінки документації класу.

-використовувати
Створіть сторінку з інформацією про перехресні посилання. За замовчуванням ця сторінка не є
генерується.

Інформацію про перехресні посилання можна отримати, натиснувши кнопку з написом
"Використовувати" на панелі навігації.

Сторінка «Використання» перелічує всі класи/інтерфейси в наборі документації
розширити/реалізувати розглянутий клас (тип); поля типу; методи або
конструктори, що приймають параметр типу; методи, що повертають тип; і
методи або конструктори, що викидають тип.

-автор
Включіть інформацію про автора у вихідні дані.

Якщо вказано, інформацію про автора, як зазначено за допомогою @автор тег у javadoc
коментарі включені у вихідні дані. За замовчуванням, @автор теги ігноруються.

-версія
Включіть інформацію про версію у вихідні дані.

Якщо вказано, інформацію про версію, як зазначено за допомогою @version тег у javadoc
коментарі включені у вихідні дані. За замовчуванням, @version теги ігноруються.

- текст ліцензії
Припустимо, що перший коментар у кожному вихідному файлі містить текст ліцензії, і додайте
інформацію про ліцензію в нижній колонтитул кожної згенерованої сторінки класу.

Це спеціальний варіант gjdoc і несумісний із Sun javadoc.

Ця опція призначена для використання з безкоштовними проектами з відкритим вихідним кодом
зазвичай додається до стандартного ліцензійного коментаря, якщо є юридичні причини
за включення ліцензії до документації.

-docfilessubdirs
Рекурсивно скопіюйте всі файли в doc-файли підкаталог кожного каталогу пакунків.

Зазвичай лише файли в doc-файли підкаталог копіюється без спадання
рекурсивно.

-excludedocfillesssubdir ім'я:ім'я: ...
Не копіюйте деякі каталоги безпосередньо під файлом doc-файли підкаталоги, коли
рекурсивно спадання.

Аргументом цієї опції має бути список імен каталогів, розділений двокрапкою.

Цей варіант має сенс лише в тому випадку, якщо -docfilessubdirs також уточнюється. В даному випадку будь-який
підкаталог, розташований безпосередньо під a doc-файли каталог опускається, якщо вказано.

виготовлений на замовлення документація Теги

- tagletpath список шляхів
Пошук список шляхів при завантаженні наступних класів Taglet, зазначених за допомогою - таглет.

список шляхів має бути один або кілька шляхів до каталогу або файлу jar, розділених вашим
роздільник шляху платформи (зазвичай : or ;).

- таглет назви класу
Зареєструйте Taglet.

назви класу має бути повною назвою реалізованого класу Java
com.sun.tools.doclets.Taglet.

Класи Taglet будуть завантажені з шляху до класу, зазначеного за допомогою - tagletpath, з
шлях до класу, зазначений за допомогою -класний шлях і зі шляху до класу за замовчуванням.

Дивіться документацію на com.sun.tools.doclets.Taglet для подальшої інформації.

Зауважте, що для простих тегів також є -таг.

-таг tagspec
Зареєструйте загальний Taglet.

Формат tagspec повинно бути : :" ".

тег — ім’я тегу, яке має відповідати, без головного знаку @.

прапори є одним або більше з наступних символів, де кожен символ визначає a
контекст вихідного коду, в якому тег має бути розпізнано.

a всі контексти

c конструктори

f поля

m методика

o огляд

p пакети

t типи (класи, інтерфейси, винятки, помилки)

X спеціальний символ, який тимчасово повністю вимикає Taglet.

тегхед це рядок, який відображатиметься в заголовку розділу, присвяченого тегу в
питання.

Наприклад, щоб визначити відповідність тегу @cvsid що має бути прийнято в огляді,
сторінки пакету та типу, які позначені заголовком CVS ID, Ви були б
вказати:

-тег cvsid:tpo:"CVS ID"

Скажімо, що містить коментар класу javadoc

@cvsid $Id: cp-tools.texinfo,v 1.9 2012-03-07 15:27:27 gnu_andrew Exp $

Тоді вихідний HTML-код буде містити щось на зразок

Ідентифікатор CVS:
$Id: cp-tools.texinfo,v 1.9 2012-03-07 15:27:27 gnu_andrew Exp $

Робота Інше Доклети

-docletpath список шляхів
Пошук список шляхів під час завантаження класів для Doclet, зазначеного за допомогою - доклет.

список шляхів має бути один або кілька шляхів до каталогу або файлу jar, розділених вашим
роздільник шляху платформи (зазвичай : or ;).

- доклет className
Запустіть вказаний документ замість стандартного HtmlDoclet.

className має бути повною назвою класу, який має загальнодоступне значення за замовчуванням
конструктор і містять метод з таким підписом:

імпорт com.sun.javadoc.RootDoc;
публічний статичний логічний початок (RootDoc ​​rootDoc)

Класи Doclet будуть завантажені з шляху до класу, зазначеного за допомогою -docletpath, з
шлях до класу, зазначений за допомогою -класний шлях і зі шляху до класу за замовчуванням.

Команда старт метод повинен обробляти інформацію, надану API Doclet через rootDoc
і повернутися правда на успіх, false про невдачу.

Якщо ви використовуєте сторонній doclet, зверніться до його документації для отримання додаткової інформації
інструкції. Зауважте, що підтримка сторонніх доклетів є експериментальною. Будь ласка
повідомляйте про будь-які проблеми, з якими ви зіткнулися, або надайте зворотній зв’язок після успішного виконання
сторонні аплети.

Цю опцію можна вказати кілька разів, у цьому випадку всі доклети виконуються
з тим самим інформаційним деревом, що відкривається через API Doclet для кожного запуску Doclet.

Додавання Інформація до Вихід

-заголовок вікна текст
Скористайтесь текст як префікс заголовка вікна браузера.

Якщо вказано, заголовок вікна браузера для кожної сторінки матиме префікс текст
замість рядка за замовчуванням Згенеровано API документація.

текст має бути звичайним текстом (він не повинен містити тегів HTML).

-докт текст
Установіть для тексту заголовка оглядової сторінки значення текст.

текст має бути короткий рядок звичайного тексту.

При створенні документації для окремого пакета вказівка ​​цієї опції примусово
створення оглядової сторінки.

- заголовок htmltext
додавати htmltext у правому верхньому куті кожної створеної сторінки. htmltext звичайно
встановити назву проекту, що документується.

-нижній колонтитул htmltext
додавати htmltext у правому нижньому куті кожної створеної сторінки. htmltext часто
встановити те саме значення, що й для - заголовок.

-низу htmltext
додавати htmltext до самого низу кожної створеної сторінки, охоплюючи всю ширину
сторінку. Коли вказано, htmltext зазвичай складається з повідомлення про авторські права та/або
посилання на інші сторінки проекту.

-додати таблицю стилів файл
Доповніть таблиці стилів CSS за замовчуванням за допомогою вказаної користувачем таблиці стилів файл.

Дана таблиця стилів просто завантажується кожною сторінкою HTML на додаток до стандартної
one, як остання таблиця стилів.

Зауважте, що застосовуються каскадні правила CSS. Тобто ваші властивості стилю будуть тільки
призначається, якщо вони мають вищий каскадний порядок, ніж gjdocстиль за замовчуванням. Один простий
спосіб переконатися, що це так, - оголосити свої перевизначення важливо!.

Побачитиhttp://www.w3.org/TR/REC-CSS2/cascade.html#каскадний порядок>.

-група заголовок pkgwildcard:pkgwildcard: ...
Розмістіть дані пакети в окрему групу на сторінці огляду.

Першим аргументом має бути короткий простий текст, який використовується як заголовок
група пакетів. Другим аргументом має бути список пакетів, розділених двокрапкою
символи підстановки. Група складатиметься з усіх пакетів у наборі документації, ім’я яких
відповідає будь-якому із заданих символів підстановки.

Існує лише один символ підстановки, *, що відповідає обом літерам у назві пакета
компоненти та . розділяючи компоненти імені пакета. Наприклад, j*регулярний вираз б
пакет сірників java.util.regex. Більш корисним буде приклад javax.swing* щоб відповідати
javax.swing і всі його підпакети.

Цю опцію можна вказати кілька разів.

FIXME: Інформація про вкладення груп тут.

gjdoc -group "Основні класи" 'java*' \
-група "Swing" 'javax.swing*' \
-група "XML API" 'javax.xml*' \
-група "Інші розширення" javax* \
...

-огляд файл
Додайте фрагмент тіла XHTML з файл на сторінку огляду.

файл має містити фрагмент XHTML з HTML тіло тег як кореневий вузол.

Цей параметр можна використовувати для надання опису набору документації в цілому.

Якщо вказано, перше речення фрагмента буде розміщено над таблицями
перелік документованих пакетів разом із посиланням на повну копію фрагмента
який розміщений під таблицями.

При створенні документації для окремого пакета вказівка ​​цієї опції примусово
створення оглядової сторінки.

-файл таблиці стилів файл
Використовуйте таблицю стилів CSS в файл замість стандартних таблиць стилів CSS.

Якщо ви хочете замінити лише частини таблиць стилів за замовчуванням, використовуйте -додати таблицю стилів
замість цього.

-заголовок текст
Не підтримується. Скористайтесь -докт текст замість цього.

- файл довідки файл
Наразі цей параметр ігнорується.

Після впровадження він використовуватиме фрагмент XHTML у файл для вмісту сторінки допомоги
замість довідкового тексту за замовчуванням.

Управління Вихідні дані.

-d каталог
Помістіть усі вихідні файли в каталог (і підкаталоги). каталог буде створено
якщо він не існує, включаючи всі неіснуючі батьківські каталоги та всі необхідні
підкаталоги.

Якщо не вказано, вихід буде розміщено в поточному каталозі.

- локаль ім'я
Використовуйте локаль ім'я замість локалі за замовчуванням для всіх цілей.

ім'я має бути специфікатором локалі у формі ll_CC[_VAR] де ll є двома нижньою літерою
літерний код мови ISO-639, CC це необов’язкова країна з двома літерами ISO-3166
код і VAR є необов'язковим варіантом коду. Наприклад, en вказує англійську мову, en_US
визначає американську англійську мову та en_US_WIN визначає девіантний варіант американської англійської мови
місцевий.

Зауважте, що семантика цього параметра точно відповідає семантиці конструкторів
класу java.util.Locale.

Цей параметр наразі визначає лише те, який Collator використовується для сортування вихідних даних
елементів. Це означає, що локаль матиме ефект лише тоді, коли ви використовуєте не-
Символи ASCII в ідентифікаторах.

-набір символів набір
Не підтримується. Замінити вказане кодування у вихідних XHTML-файлах на дане
by набір.

Якщо цей параметр не вказано, вибирається специфікація кодування у вихідному XHTML
відповідати кодуванню, яке використовується під час запису файлу (кодування, наведене з -доценкодування,
або кодування за замовчуванням для вашої платформи).

Семантика для набір вказані тут:
<http://www.w3.org/TR/2000/REC-xml-20001006#NT-EncName>. Для всіх практичних цілей,
вони ідентичні параметрам інших опцій, які приймають параметри набору символів.

Цей параметр тут для сумісності з javadoc і слід уникати.

-доценкодування набір
Використовуйте задане кодування кодування під час запису вихідних файлів замість файлів вашої платформи
кодування за замовчуванням.

Приклади для набір він має США-ASCII, ISO-8859-1 or UTF-8.

Семантика цього параметра точно відповідає семантиці конструкторів класу
java.util.Locale.

-дійсний html
Примусово генерувати дійсний код XHTML. Це порушує сумісність із традиційним
Інструмент Javadoc певною мірою.

Якщо вказано цю опцію, імена прив’язки будуть змінені, щоб вони були дійсними
відповідно до специфікації XHTML 1.1. Однак набір документації, створений за допомогою
цей параметр неможливо пов’язати належним чином за допомогою традиційного інструменту Javadoc. Це може
бути пов’язаними з використанням Gjdoc, однак.

Без цього параметра імена прив’язки для членів виконуваного класу використовують традиційні
формат, наприклад: "foo(String,int[])". Це сумісно з традиційним
інструмент Javadoc, але відповідно до специфікацій HTML 4.0 і XHTML 1.0 і 1.1,
цей формат містить заборонені символи. Дужки, квадратні дужки та кома
не допускаються в іменах якорів.

-baseurl URL
Встановіть URL-адресу сторінки відносно URL на кожну створену сторінку.

Якщо ви створюєте документацію, яка буде доступна виключно на певній
URL, ви повинні використовувати цю опцію, щоб вказати цю URL-адресу.

Це може допомогти уникнути певних атак перенаправлення, які використовуються спамерами, і це може бути корисно
для певних веб-клієнтів.

Багатослівність Опції

-спокійно
Придушити весь вихід, крім попереджень і повідомлень про помилки.

-вербозний
Будьте дуже багатослівними про що gjdoc робить.

Наразі цей параметр ігнорується.

Віртуальний машина Опції

Сонце javadoc інструмент, схоже, заснований на явак і як такий він працює на віртуальній машині
рівні. gjdoc, навпаки, є чистою програмою Java.

Таким чином, gjdoc може лише підробити або імітувати наступні параметри рівня ВМ.

-класний шлях список шляхів
Налаштуйте віртуальну машину шлях до класу до список шляхів.

У більшості випадків слід використовувати -docletpath or - tagletpath замість цього варіанту.

список шляхів має бути один або кілька шляхів до каталогу або файлу jar, розділених вашим
роздільник шляху платформи (зазвичай : or ;).

Якщо цей параметр не перехоплено на рівні обгортки, gjdoc наразі підробляє це
покликання System.setProperty("java.class.path", список шляхів); і виводить попередження.

-bootclasspath список шляхів
Налаштуйте віртуальну машину bootclasspath до список шляхів.

Якщо цей параметр не перехоплено на рівні обгортки, gjdoc виводить попередження.

-Jvmopt
Передайте довільний параметр до віртуальної машини gjdoc біжить далі.

Якщо цей параметр не перехоплено на рівні обгортки, gjdoc намагається наслідувати
і виводить попередження.

Наразі лише варіант ВМ -D для налаштування властивостей системи емулюється.

Використовуйте gjdoc-4.8 онлайн за допомогою сервісів onworks.net