Tento průvodce 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 |
---|---|
Vybrat typy, pro které se má dokumentace Javadoc generovat |
V seznamu zaškrtněte nebo naopak odstraňte zaškrtnutí z políček, a tím přesně určete, které typy se mají exportovat do souboru JAR. Tento seznam se inicializuje na základě výběru v pracovní ploše. Vybrat lze najednou vždy jen jeden projekt, protože při spuštění nástroje Javadoc je možno použít v daném okamžiku pouze jednu cestu ke třídě projektu. |
Vytvořit dokumentaci Javadoc pro členy s viditelností |
|
Použít standardní doclet |
Spusťte příkaz Javadoc se standardním docletem (výchozí nastavení)
|
Použít vlastní doclet |
K vygenerování dokumentace použijte 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. |
Generovat index pro každé písmeno | Vytvoří index pro každé písmeno. Tato volba je dostupná, 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 page. Tato volba je dostupná, 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. |
Doplňující volby dokumentace Javadoc |
Zde můžete přidat libovolný počet dalších voleb: volby pro vlastní doclet, volby pro systém VM nebo volby kompatibility s verzí JRE 1.4. |
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 místo určení 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í.