Rapporter for API-bruk

En rapport for API-bruk beskriver et sett med referanser fra et sett med bunter til et annet sett med bunter. Du kan generere en rapport med Ant-oppgaven for API-bruk. Det finnes et brukergrensesnitt for konfigurering og generering av en rapport i dialogboksen Eksterne verktøy. Når du skal opprette en ny bruksskanningskonfigurasjon, dobbeltklikker du på konfigurasjonstypen Rapport for API-bruk.

Flippen Rapport for API-bruk

På flippen Rapport for API-bruk kan du konfigurere analysen.

Følgende eksempel viser en konfigurasjon for å trekke ut alle referanser til Eclipse-bunter i en 3.4-installasjon.

Flippen Rapport for API-bruk


Alternativ

Beskrivelse

Standardverdi

Analyser Du kan velge hva du vil analysere. Det kan være API-basis, måldefinisjon eller en katalog med bunter. Du kan også velge å bare generere HTML for en eksisterende rapport. Du kan bare velge ett alternativ, med mulighet for å konfigurere alternativet. Du kan for eksempel gå til preferansesiden for API-basis for å redigere eksisterende basiser hvis du velger å analysere en API-basis. API-basis
Analyser > API-basis Du kan velge en hvilken som helst API-basis fra kombinasjonsboksen for analyse Standardbasis eller tom
Analyser > Basiser... Gir tilgang til preferansesiden API-basiser der du kan konfigurere basisen som skal analyseres.  
Analyser > Måldefinisjon Du kan velge en hvilken som helst måldefinisjon fra kombinasjonsboksen for analyse Aktiv måldefinisjon eller tom
Analyser > Mål Gir tilgang til preferansesiden Målplattform der du kan konfigurere måldefinisjonen som skal analyseres.  
Analyser > Katalog Du kan oppgi absolutt bane til en katalog som inneholder buntene. tom
Analyser > Bla gjennom... Gjør det mulig å bla etter en mappe med bunter som skal analyseres.  
Analyser > Generer HTML-rapport for eksisterende bruksskanning Gjør det mulig å opprette en rapport for en eksisterende skanning uten å utføre analysen igjen.  
Søk etter > Referanser til Gjør det mulig å oppgi navnet (eller tilsvarende RegEx) for bunten du vil se referanser til. Se på følgende eksempel: org\.eclipse.*. I dette eksempelet sier vi at vi vil se alle referanser til alle bunter med navn som begynner med org.eclipse.. tom
Søk etter > API-referanser Gjør det mulig å søke etter API-referanser. ikke avmerket
Søk etter > Interne referanser Gjør det mulig å søke etter interne referanser. avmerket
Søk etter > Ugyldig API-bruk Gjør det mulig å søke etter ugyldig API-bruk, det vil si bruk av API-medlemmer med begrensninger. ikke avmerket
Søk i > Bunter som samsvarer Gjør det mulig å oppgi navnet (eller tilsvarende RegEx) for bunten(e) som du vil søke i etter referanser fra for eksempel et søkeomfang. Se på følgende eksempel: .*. I dette eksempelet sier vi at vi vil søke i alle bunter med navn som samsvarer med en hvilken som helst tegnsekvens. Du oppnår det samme ved å la feltet være tomt. tom
Rapportering > Rapporttype Gjør det mulig å velge mellom to HTML-rapportformater. Hvis Rapport for refererte bunter (produsenter) blir valgt, viser rapporten alle bunter som inneholder typene det blir referert til i buntene det er søkt i. Hvis Rapport for refererende bunter (forbrukere) blir vlgt, blir rapporten ordnet slik at den viser alle buntene i søkeomfanget som inneholder referanser.

Når du bytter rapportype, må du kontrollere at de regulære uttrykkene Referanser til og Samsvarende bunter har riktige verdier. Hvis du bruker et jokertegnuttrykk som .* i en innstilling, må du ofte flytte jokertegnet til den andre innstillingen når du bytter til en annen rapporttype, for å få den rapporten du har bruk for.

Rapport for refererte bunter (produsenter)
Rapportering > Rapportutdataplassering Gjør det mulig å oppgi absolutt bane til der genererte rapporter skal plasseres. tom
Rapportering > Bla gjennom... Gjør det mulig å velge plassering for rapportutdata.  
Rapportering > Rydd i rapportkatalog før rapportering av nye resultater Gjør det mulig å tømme en eksisterende XML-rapportplassering før rapportering av nye resultater fra skanning. Vær oppmerksom på at dette alternativet fjerner den oppgitte rapportkatalogen fullstendig hvis den finnes, og at alle underordnede kataloger også blir fjernet. ikke avmerket
Rapportering > Opprett HTML-rapporter Konverterer alle XML-utdata til formatert HTML og plasserer rapportene i <rapportplassering>\html ikke avmerket
Rapportering > Rydd i HTML-rapportplassering Gjør det mulig å tømme en eksisterende HTML-plassering før du oppretter nye rapporter. Vær oppmerksom på at dette alternativet fjerner den oppgitte HTML-katalogen fullstendig hvis den finnes, og at alle underordnede kataloger også blir fjernet. Dette alternativet er bare aktivert hvis du har valgt alternativet Opprett HTML-rapporter beskrevet ovenfor. ikke avmerket
Rapportering > Åpne rapport når søket er fullført Åpner HTML-rapporten når analysen er fullført. Dette alternativet er bare aktivert hvis du har valgt alternativet Opprett HTML-rapporter beskrevet ovenfor. ikke avmerket
Rapportering > Beskrivelse Gjør det mulig å oppgi en lesbar beskrivelse for rapporten. tom

Flippen Mønstre

På flippen Mønstre kan du opprette en rekke mønstre for regulære uttrykk til kontroll av bruksanalysen. Det finnes for øyeblikket tre typer av mønstre:

  1. Arkivmønster - Gjør det mulig å oppgi nestede arkiver som skal ignoreres under en analyse.
  2. Pakkemønster - Gjør det mulig å oppgi pakker som skal være API eller interne, uten å oppdatere buntmanifestet.
  3. Rapportkonverteringsmønster - Gjør det mulig å opprette et regulært uttrykk for pakkenavn som skal brukes til å filtrere referanser som blir rapportert. Alle rapporterte referanser filtreres basert på fullt kvalifisert pakkenavn.

Flippen Mønstre


Alternativ

Beskrivelse

Standardverdi

Legg til... Gjør det mulig å legge til et nytt mønster. Denne knappen starter mønsterveiviseren.  
Rediger Gjør det mulig å redigere det valgte mønsteret. Du kan bare redigere ett mønster om gangen.  
Fjern Gjør det mulig å fjerne det eller de valgte mønstrene. Du kan fjerne flere mønstre om gangen.  

Beslektede oppgaver

Sammenlikne med en API-basis
Konfigurere en basis

Beslektet referanse

Preferanser for API-basis
Veiviser for mønster for API-bruk