Az API használat jelentés leírja a kötegek egyik halmazából a kötetek másik halmazára mutató referenciákat. Egy jelentés az API használat Ant feladat használatával állítható elő. A Külső eszközök párbeszédablakban rendelkezésre áll egy felhasználói felület, ahol konfigurálhatja és előállíthatja a jelentést. Egy új használat elemzési konfiguráció létrehozásához egyszerűen kattintson duplán az API használat jelentés konfigurációtípusra.
Az API használat jelentés lapon beállíthatja az elemzést.
A következő példa egy olyan konfigurációt mutat be, amely egy 3.4 változatú telepítésben lévő Eclipse kötegekre mutató referenciákat nyeri ki.

| Option |
Leírás |
Alapértelmezés |
|---|---|---|
| Elemzés | Kiválaszthatja, hogy mit szeretne elemezni: ez egy API alapsor, egy célmeghatározás vagy egy köteg könyvtár lehet. Kiválaszthatja azt is, hogy csak egy meglévő jelentést állítson elő HTML formátumban. Csak egy beállítást választhat ki, és minden beállítás konfigurálható. Vagyis ha egy API alapsor elemzését választja, akkor elmehet az API alapsorok beállítási oldalra, ahol szerkesztheti a meglévő alapsorokat. | API alapsor |
| Elemzés > API alapsor | Kiválaszthat egy elemezni kívánt API alapsort a legördülő listából | Alapértelmezett alapsor vagy üres |
| Elemzés > Alapsorok... | Hozzáférést biztosít az API alapsorok beállítási oldalhoz, ahol beállíthatja az elemezni kívánt alapsort. | |
| Elemzés > Célmeghatározások | Kiválaszthatja az elemezni kívánt célmeghatározást a legördülő listából | Az aktív célmeghatározás vagy üres |
| Elemzés > Célok | Hozzáférést biztosít az Célplatform beállítási oldalhoz, ahol beállíthatja az elemezni kívánt célmeghatározást. | |
| Elemzés > Könyvtár | Beírhatja a kötegeket tartalmazó könyvtár abszolút útvonalát. | üres |
| Elemzés > Tallózás... | Tallózással megkeresheti az elemezni kívánt kötegek könyvtárát. | |
| Elemzés > HTML jelentés létrehozása meglévő használat elemzéshez | Létrehozhat egy jelentést egy meglévő elemzéshez és nem kell újra végrehajtania az elemzést. | |
| Keresés > Hivatkozások a következőre | Megadhatja a köteg nevét (vagy egy egyeztető reguláris kifejezést), amelynek látni szeretné a hivatkozásait.
Nézzük meg az alábbi példát: org\.eclipse.*. Ebben a példában az org.eclipse. névvel kezdődő bármely kötegre mutató összes referenciát szeretnénk látni. |
üres |
| Keresés > API hivatkozások | Lehetővé teszi az API hivatkozások keresését. | nincs bejelölve |
| Keresés > Belső hivatkozások | Lehetővé teszi a belső hivatkozások keresését. | bejelölve |
| Keresés > Illegális API használat | Lehetővé teszi az illegális API használat (vagyis a korlátozott API tagok használatának) keresését. | nincs bejelölve |
| Keresés a következőben > Megfelelő kötegek | Megadhatja a köteg nevét (vagy egy egyeztető reguláris kifejezést), amelyekből referenciákat szeretne keresni, vagyis a keresés hatókörét.
Nézzük meg az alábbi példát: .*. Ebben a példában minden olyan kötegben keresni szeretnénk, amelynek neve megfelel bármely karaktersorozatnak.
A mező üresen hagyásának ugyanez az eredménye. |
üres |
| Jelentéskészítés > Jelentéstípus | Két HTML
jelenítésformátum közül választhat. Ha a Hivatkozott kötegek jelentés
(Előállítók) típust választja, akkor a jelentés azokat a kötegeket
sorolja fel, amelyek a keresett kötegekben hivatkozott típusokat
tartalmazzák. Ha a Hivatkozó kötegek jelentés (Fogyasztók) típust
választja, akkor a jelentés azokat a keresési hatókörben lévő kötegeket
sorolja fel, amelyek a hivatkozásokat tartalmazzák.
A jelentéstípusok átváltásakor ellenőrizze, hogy a Hivatkozások a következőre és a Megfelelő kötegek reguláris kifejezések a helyes értékekkel rendelkeznek-e. Ha az egyik beállításban helyettesítő karakteres kifejezést (például a .*) használ, az átváltás egy másik jelentéstípusra gyakran megköveteli, hogy a leghasznosabb jelentés előállítása érdekében áthelyezze a helyettesítő karaktert a másik beállításba. |
Hivatkozott kötegek jelentés (Előállítók) |
| Jelentéskészítés > Jelentés kimeneti helye | Megadhatja az abszolút útvonalat, ahol az előállított jelentéseket tárolni szeretné. | üres |
| Jelentéskészítés > Tallózás... | Kiválaszthatja a jelentések kimeneti helyét. | |
| Jelentéskészítés > Jelentés könyvtár takarítása új eredmények jelentése előtt | Kitakaríthatja a meglévő XML jelentések helyét, mielőtt az elemzés eredményeket jelentene. Megjegyzés: ez a beállítás teljesen eltávolítja a megadott jelentés könyvtárat, ha az létezik, és az összes leszármazott könyvtár is rekurzívan el lesz távolítva. | nincs bejelölve |
| Jelentéskészítés > HTML jelentések létrehozása | Átalakítja az összes XML kimenetet formázott HTML dokumentummá, és elhelyezi azt a <jelentés_helye>\html könyvtárban |
nincs bejelölve |
| Jelentéskészítés > HTML jelentés helyének takarítása | Kitakaríthatja a meglévő HTML jelentések helyét új jelentések létrehozása előtt. Megjegyzés: ez a beállítás teljesen eltávolítja a megadott HTML könyvtárat, ha az létezik, és az összes leszármazott könyvtár is rekurzívan el lesz távolítva. Ez a beállítás csak akkor engedélyezhető, ha kiválasztja a fent említett HTML jelentések létrehozása beállítást. | nincs bejelölve |
| Jelentéskészítés > Jelentés megnyitása a keresés befejeződésekor | Megnyitja a HTML jelentést, amikor az elemzés kész. Ez a beállítás csak akkor engedélyezhető, ha kiválasztja a fent említett HTML jelentések létrehozása beállítást. | nincs bejelölve |
| Jelentéskészítés > Leírás | Beírhat egy értelmes leírást a jelentéshez. | üres |
A Minták lapon különféle reguláris kifejezés mintákat hozhat létre, amelyekkel szabályozhatja a használat elemzést. Jelenleg háromféle támogatott minta létezik:

| Beállítás |
Leírás |
Alapértelmezés |
|---|---|---|
| Hozzáadás... | Hozzáadhat egy új mintát. A gombra kattintva elindul a Minta varázsló. | |
| Szerkesztés | Lehetővé teszi a jelenleg kijelölt minta szerkesztését. Egyszerre csak egy minta szerkeszthető. | |
| Eltávolítás | Eltávolíthatja a kijelölt mintá(ka)t. Egyszerre több mintát is eltávolíthat. |

Összehasonlítás egy API alapsorral
Alapsor beállítása
