Průvodce generováním dokumentace Javadoc umožňuje generovat dokumentaci Javadoc. Je to uživatelské rozhraní pro nástroj javadoc.exe, který je k dispozici v sadě Java JDK. Kompletní
dokumentaci k nástroji Javadoc najdete na webové stránce na adrese Sun's Javadoc Tool.
Výběr typu:
|
Volba |
Popis |
|---|---|
|
Příkaz dokumentace Javadoc |
Určete, který příkaz má být použit k vygenerování dokumentace Javadoc. |
|
Vybrat typy, pro které bude dokumentace Javadoc generována |
V seznamu zaškrtněte nebo naopak vymažte zaškrtnutí polí, a určete tak typy, které chcete exportovat. Tento seznam se inicializuje na základě výběru v pracovní ploše. |
|
Vytvořit dokumentaci Javadoc pro členy s viditelností |
|
|
Použít standardní doclet |
Spustit příkaz Javadoc se standardním docletem (výchozí nastavení)
|
|
Použít vlastní doclet |
Ke generování dokumentace použít vlastní doclet
|
Argumenty standardního docletu (dostupné po vybrání volby Použít standardní doclet):
|
Volba |
Popis |
|---|---|
|
Název dokumentu |
Zadejte název dokumentu. |
| Generovat stránku použití | Tuto volbu vyberte, pokud chcete, aby dokumentace obsahovala stránku použití. |
| Generovat strom hierarchie | Tuto volbu vyberte, pokud chcete, aby dokumentace obsahovala stránku stromu. |
|
Generovat navigační panel |
Tuto volbu vyberte, pokud chcete, aby dokumentace obsahovala navigační panel (záhlaví a zápatí). |
| Generovat index | Tuto volbu vyberte, pokud chcete, aby dokumentace obsahovala stránku Index. |
| Rozdělit index po písmenech | Vytvoří index pro každé písmeno. Tato volba je povolená, když je vybraná volba Generovat index. |
| @author | Tuto volbu vyberte, pokud chcete, aby se vytvořila dokumentace pro značku @author. |
| @version | Tuto volbu vyberte, pokud chcete, aby se vytvořila dokumentace pro značku @version. |
| @deprecated | Tuto volbu vyberte, pokud chcete, aby se vytvořila dokumentace pro značku @deprecated. |
| deprecated list | Tuto volbu vyberte, pokud chcete, aby dokumentace obsahovala stránku Deprecated. Tato volba je povolená, když je vybraná volba @deprecated. |
| Vyberte odkazované třídy, ke kterým by měla dokumentace Javadoc vytvořit odkazy |
Zadejte, ke kterým dalším dokumentacím by měla dokumentace Javadoc vytvořit odkazy, když se odkazuje na jiné typy.
|
| Seznam stylů | Vyberte seznam stylů, který se má použít |
Obecné volby dokumentace Javadoc:
|
Volba |
Popis |
|---|---|
|
Přehled |
Určuje, že dokumentace Javadoc má získat text pro přehledovou dokumentaci z daného souboru. Tento text se umístí do souboru overview-summary.html. |
|
Volby virtuálního stroje |
Na tomto místě můžete přidat libovolný počet doplňkových voleb virtuálního stroje. |
|
Doplňující volby dokumentace Javadoc |
Zde můžete přidat libovolný počet dalších voleb: Volby pro vlastní doclet nebo volby kompatibility JRE 1.4. |
|
Kompatibilita zdroje JRE |
Kompatibilita zdroje JRE, kterou má akceptovat nástroj javadoc. |
|
Uložit nastavení tohoto exportu dokumentace Javadoc jako skript Ant |
Zadejte uložení skriptu Ant, který provede určený export dokumentace Javadoc bez nutnosti použití průvodce. Existující skript Ant lze tímto průvodcem upravit (Z kontextové nabídky u vygenerovaného skriptu Ant použijte příkaz Otevřít průvodce vytvořením dokumentace Javadoc) |
| Otevřít generovaný indexový soubor v prohlížeči | Otevře vygenerovaný soubor index.html v prohlížeči (Tato volba je dostupná pouze při použití standardního docletu) |
Klepnutím na Dokončit spusťte generování dokumentace Javadoc. Pokud je cíl odlišný od umístění určeného na stránce umístění dokumentace Javadoc projektu, objeví se dotaz, zda chcete umístění dokumentace Javadoc pro daný projekt nastavit na novou cílovou složku. V takovém případě všechna vyvolání příkazu Otevřít externí dokumentaci Javadoc budou používat nyní vytvořenou dokumentaci.
Bude spuštěn nový proces a vygenerování proběhne na pozadí. Otevřete pohled Konzola (Okno > Zobrazit pohled > Konzola), chcete-li zobrazit postup a stav generování.
