Javadoc genereren kunt u Javadoc genereren. De wizard fungeert als gebruikersinterface voor het hulpprogramma javadoc.exe, dat beschikbaar is in JDK. Ga
naar de webpagina Javadoc 1.4.2
Tool van Sun voor een volledige beschrijving.
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 JDK. Ga
naar de webpagina Javadoc 1.4.2
Tool van Sun voor een volledige beschrijving.
Beschikbare typen:
|
Optie |
Beschrijving |
|---|---|
|
Javadoc-opdracht |
Geef hier de opdracht aan waarmee u de Javadoc wilt genereren. |
|
Selecteer typen waarvoor Javadoc wordt gegenereerd |
Selecteer in de lijst de vakjes van de typen die u wilt exporteren. Deze lijst wordt geïnitialiseerd aan de hand van de selectie in de workbench. |
|
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 |
Hier geeft u een documenttitel op. |
| Pagina voor gebruik genereren | Selecteer deze optie als u wilt dat de documentatie een pagina voor gebruik bevat. |
| Hiërarchie 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 navigatiebalk 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. Deze optie is 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. |
| Selecteer de gekoppelde archieven en projecten waarvoor koppelingen moeten worden gegenereerd |
U kunt opgeven naar welke documentatie Javadoc koppelingen moet maken wanneer
naar andere typen wordt verwezen.
|
| Stijlblad | Selecteer het stijlblad dat u wilt gebruiken. |
Algemene Javadoc-opties:
|
Optie |
Beschrijving |
|---|---|
|
Overzicht |
De tekst voor de overzichtsinformatie moet door Javadoc worden opgehaald uit het opgegeven bestand. Deze tekst wordt geplaatst in overview-summary.html. |
|
VM-opties |
Hier kunt u naar keuze extra VM-opties toevoegen. |
|
Extra Javadoc-opties |
Hier kunt u naar keuze extra opties toevoegen: Aangepaste doclet-opties of
opties voor JRE 1.4-compatibiliteit. |
|
JRE-broncompatibiliteit |
De JRE-broncompatibiliteit waarmee de Javadoc-tool moet werken. |
|
Instellingen van deze Javadoc 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 contextmenu 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 de bestemming afwijkt van de locatie die is opgegeven op de projectpagina Javadoc-locatie, wordt gevraagd of u de nieuwe map wilt instellen als de Javadoc-locatie van het project. Als u hiertoe besluit, wordt voor alle aanroepen van 'Externe Javadoc openen' de nu gemaakte documentatie gehanteerd.
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 genereerproces te volgen.
