Met behulp van de wizard
Javadoc genereren kunt u Javadoc genereren. De wizard fungeert als gebruikersinterface voor het hulpprogramma javadoc.exe, dat beschikbaar is in de Java JDK. Ga
naar de webpagina Sun's Javadoc Tool voor een volledige beschrijving.
Beschikbare typen:
Optie |
Beschrijving |
---|---|
Selecteer typen waarvoor Javadoc wordt gegenereerd |
Selecteer de vakjes in de lijst van de typen die u naar het JAR-bestand wilt exporteren. Deze lijst wordt geïnitialiseerd aan de hand van de selectie in de workbench. Slechts één project kan tegelijk worden geselecteerd, omdat slechts een klassenpad van één project kan worden gebruikt op het moment dat een Javadoc-tool wordt uitgevoerd. |
Javadoc maken voor leden met zichtbaarheid |
|
Standaarddoclet gebruiken |
Javadoc-opdracht starten met standaarddoclet (standaard)
|
Aangepaste doclet gebruiken |
Een aangepaste doclet gebruiken voor het genereren van documentatie
|
Standaarddocletargumenten (beschikbaar als Standaarddoclet gebruiken is geselecteerd):
Optie |
Beschrijving |
---|---|
Documenttitel |
Geef een documenttitel op. |
Pagina voor gebruik genereren | Selecteer deze optie als u wilt dat de documentatie een pagina voor gebruik bevat. |
Hiërarchiestructuur genereren | Selecteer deze optie als u wilt dat de documentatie een structuurpagina bevat. |
Navigatiebalk genereren |
Selecteer deze optie als u wilt dat de documentatie een navigatiepagina bevat (kop- en voettekst). |
Index genereren | Selecteer deze optie als u wilt dat de documentatie een indexpagina bevat. |
Indexeren per letter | Een index per letter maken. Ingeschakeld als Index genereren is geselecteerd. |
@author | Selecteer deze optie als u de tag @author wilt documenteren. |
@version | Selecteer deze optie als u de tag @version wilt documenteren. |
@deprecated | Selecteer deze optie als u de tag @deprecated wilt documenteren. |
Gedeprecieerde lijst | Selecteer deze optie als u wilt dat de documentatie de pagina Gedeprecieerd bevat. Ingeschakeld als de optie @deprecated is geselecteerd. |
Verwijzingsklassen selecteren waarheen Javadoc koppelingen moet maken |
U kunt opgeven naar welke documentatie Javadoc koppelingen moet maken als naar andere typen wordt verwezen.
|
Stijlblad | Selecteer het stijlblad dat u wilt gebruiken. |
Algemene Javadoc-opties:
Optie |
Beschrijving |
---|---|
Overzicht |
Geeft aan dat Javadoc de tekst voor de overzichtsinformatie moet ophalen uit het opgegeven bestand. Deze tekst wordt geplaatst in overview-summary.html. |
Extra Javadoc-opties |
U kunt hier een aantal extra opties toevoegen: aangepaste docletopties, VM-opties of JRE 1.4-compatibiliteitsopties. |
De instellingen van de Javadoc-export opslaan als Ant-script |
U kunt een Ant-script opslaan dat de opgegeven Javadoc-export uitvoert zonder de wizard te gebruiken. Bestaande Ant-scripts kunnen met de wizard worden gewijzigd (start de wizard Javadoc openen in het voorgrondmenu van het gegenereerde Ant-script). |
Gegenereerd indexbestand in browser openen | Hiermee wordt het gegenereerde bestand index.html in de browser geopend (alleen beschikbaar als u de standaarddoclet gebruikt). |
Klik op Voltooien om te beginnen met het genereren van Javadoc. Als er een andere bestemming is dan de locatie die is opgegeven in de projectpagina Javadoc-locatie, wordt gevraagd of u de nieuwe map wilt instellen als de Javadoc-locatie van het project. Als u hiertoe besluit, gebruiken alle oproepen van 'Externe Javadoc openen' de nu gegenereerde documentatie.
Er wordt een nieuw proces gestart en het genereren wordt op de achtergrond uitgevoerd. Open de view Console (Venster > View afbeelden > Console) om de status en de voortgang van het generatieproces te volgen.