API-gebruiksrapporten

Een API-gebruiksrapport beschrijft een set verwijzingen vanuit een set bundels naar een andere set bundels. Een rapport kan worden gegenereerd met de Ant-taak API-gebruik. Er wordt een gebruikersinterface geboden om een rapport te configureren en genereren in het dialoogvenster Externe tools. Om een nieuwe scanconfiguratie voor gebruik te maken dubbelklikt u op het configuratietype API-gebruiksrapport.

Tabblad API-gebruiksrapport

Met het tabblad API-gebruiksrapport kunt u de analyse configureren.

In het volgende voorbeeld wordt een configuratie afgebeeld om alle verwijzingen naar Eclipse-bundels in een installatie van 3.4 te extraheren.

Tabblad API-gebruiksrapport


Optie

Beschrijving

Standaardwaarde

Analyseren U kunt selecteren wat u wilt analyseren. Dit kan een API-basislijn, doeldefinitie of een directory met bundels zijn. U kunt ook selecteren om alleen HTML te genereren voor een bestaand rapport. U kunt slechts één optie selecteren, waarbij u elke optie kunt configureren. U kunt bijvoorbeeld naar de voorkeurenpagina API-basislijnen gaan om bestaande basislijnen te bewerken als u een API-basislijn analyseren selecteert. API-basislijn
Analyze > API Baseline u kunt een API-basislijn kiezen uit de combobox om te analyseren Standaard basislijn of leeg
Analyseren > Basislijnen... Hiermee kan de voorkeurenpagina API-basislijnen worden geopend om de te analyseren basislijn te configureren.  
Analyseren > Doeldefinitie U kunt een doeldefinitie kiezen uit de combobox om te analyseren De actieve doeldefinitie of leeg
Analyseren > Doelen Hiermee kunt u de voorkeurenpagina Doelplatform openen om de te analyseren doeldefinitie te configureren.  
Analyseren > Directory U kunt het absolute pad naar een directory met de bundels invoeren. leeg
Analyseren > Bladeren... Hiermee kunt u bladeren naar een map met te analyseren bundels.  
Analyseren > HTML-rapport genereren voor bestaande gebruiksscan Hiermee kunt u een rapport maken voor een bestaande scan en hoeft u de analyse niet nogmaals uit te voeren.  
Search for > References to Hiermee kunt u de naam opgeven (of bijbehorende RegEx) van de bundel waarnaar u verwijzingen wilt zien. Bekijk het volgende voorbeeld: org\.eclipse.*. In dit voorbeeld zeggen we dat we alle verwijzingen willen zien naar een bundel die begint met de naam org.eclipse.. leeg
Search for > API references Hiermee kunt u scannen naar API-verwijzingen. unchecked
Search for > Internal references Hiermee kunt u scannen naar interne verwijzingen. aan
Search for > Illegal API Use Hiermee kunt u scannen naar niet toegestaan gebruik van de API, bijv. gebruik van beperkte API-leden. unchecked
Zoeken in > Overeenkomende bundels Hiermee kunt u de naam opgeven (of bijbehorende RegEx) van de bundel(s) waarin u wilt zoeken naar verwijzingen vanuit bijv. een zoekbereik. Bekijk het volgende voorbeeld: .*. In dit voorbeeld zeggen we dat we willen zoeken in alle bundels waarvan de namen overeenkomen met elke tekenreeks. Hetzelfde effect kan worden bereikt door het veld leeg te laten. leeg
Reporting > Report Type Allows you to choose between two html report formats. If Referenced bundles report (Producers) is selected the report will list all of the bundles containing the types that are being referenced in the searched bundles. If Referencing bundles report (Consumers) is selected the report will be organized to show all of the bundles in the search scope that contain references.

When switching report types, check that the References to and Bundles matching regular expressions have the correct values. When using a wildcard expression such as .* in one setting, switching to another report type often requires the wilcard being moved to the other setting to get the most useful report.

Rapport met bundels waarnaar wordt verwezen (producenten)
Rapporteren > Uitvoerlocatie rapport Hiermee kunt u het absolute pad opgeven waar gegenereerde rapporten moeten worden geplaatst. leeg
Rapporteren > Bladeren... Hiermee kunt u de locatie selecteren waarnaar u rapporten wilt uitvoeren.  
Rapporteren > Directory voor rapporten opschonen voordat nieuwe resultaten worden gemeld Hiermee kunt u een bestaande locatie voor een XML-rapport opschonen voordat de zoekbewerking resultaten meldt. Let op, deze optie verwijdert de gehele opgegeven directory voor rapporten als deze bestaat, en alle onderliggende directory's worden ook recursief verwijderd. unchecked
Rapporteren > HTML-rapporten maken Converteert alle XML-uitvoer naar ingedeelde HTML en plaatst dit in <report location>\html unchecked
Rapporteren > Locatie voor HTML-rapport opschonen Hiermee kunt u een bestaande HTML-locatie opschonen voor u nieuwe rapporten maakt. Let op, deze optie verwijdert de gehele opgegeven HTML-directory als deze bestaat, en alle onderliggende directory's worden ook recursief verwijderd. Deze optie wordt alleen ingeschakeld als u de bovengenoemde optie HTML-rapporten maken selecteert. unchecked
Rapporteren > Rapport openen wanneer de zoekopdracht wordt voltooid Hiermee wordt het HTML-rapport geopend wanneer de analyse is voltooid. Deze optie wordt alleen ingeschakeld als u de bovengenoemde optie HTML-rapporten maken selecteert. unchecked
Rapporteren > Beschrijving Hiermee kunt u een leesbare beschrijving voor het rapport invoeren. leeg

Tabblad Patronen

Met het tabblad Patronen kunt u een aantal verschillende patronen voor reguliere expressies maken om de gebruiksanalyse te besturen. Er zijn momenteel drie ondersteunde soorten patronen:

  1. Archiefpatroon - Hiermee kunt u geneste archieven maken die bij analyse moeten worden overgeslagen.
  2. Pakketpatroon - Hiermee kunt u pakketten opgeven die API of intern zijn zonder dat uw bundelmanifest hoeft te worden bijgewerkt.
  3. Conversiepatroon rapport - Hiermee kunt u een regulere expressie voor een pakketnaam maken om verwijzingen die worden gerapporteerd te filteren. Alle gerapporteerde verwijzingen worden gefilterd met de volledig gekwalificeerde pakketnaam.

Tabblad Patronen


Optie

Beschrijving

Standaardwaarde

Toevoegen... Hiermee kunt u een nieuw patroon toevoegen. Met deze knop wordt de wizard Patroon gestart.  
Bewerken Hiermee kunt u een geselecteerd patroon bewerken. Er kan slechts één patroon tegelijk worden bewerkt.  
Wissen Hiermee kunt u de geselecteerde patronen verwijderen. You can remove more than one pattern at a time.  

Verwante taken

Vergelijken met een API-basislijn
Instellen van een basislijn

Verwante onderwerpen

API-basislijnvoorkeuren
Wizard API-gebruikspatronen