Sestavy použití API

Sestava použití API popisuje sadu odkazů z jedné sady balíků do jiné sady balíků. Sestavu lze vygenerovat s použitím úlohy ant Použití API. K dispozici je uživatelské rozhraní pro konfiguraci a vygenerování sestavy v dialogovém okně Externí nástroje. Chcete-li vytvořit novou konfiguraci procházení použití, poklepejte na typ konfigurace Sestava použití rozhraní API.

Karta Sestava použití rozhraní API

Karta Sestava použití rozhraní API vám umožňuje nakonfigurování analýzy.

Následující příklad ukazuje konfiguraci pro extrahování všech odkazů na balíky Eclipse v instalaci 3.4.

Karta Sestava použití rozhraní API


Volba

Popis

Výchozí

Analyzovat Můžete si vybrat, co chcete analyzovat. Může se jednat o úroveň baseline rozhraní API, definici cíle nebo adresář balíků. Můžete si také vybrat pouze vygenerování HTML pro existující sestavu. U každé volby umožňující nakonfigurování je možné si vybrat pouze jednu volbu. To znamená, že pokud vyberete analýzu úrovně baseline rozhraní API, můžete přejít na stránku předvoleb úrovní baseline rozhraní API, kde je možné upravovat existující úrovně baseline. Úrovně baseline rozhraní API
Analyzovat > Úrovně baseline rozhraní API Můžete si k analýze vybrat kteroukoli úroveň baseline rozhraní API z pole se seznamem. Výchozí úroveň baseline nebo prázdná
Analyzovat > Úrovně baseline... Umožňuje přístup ke stránce předvoleb Úrovně baseline rozhraní API, na které lze nakonfigurovat úroveň baseline pro analýzu.  
Analyzovat > Definice cíle Můžete si vybrat k analýze kteroukoli definici cíle z pole ze seznamem. Aktivní definice cíle nebo prázdná
Analyzovat > Cíle Umožňuje přístup ke stránce předvoleb Cílová platforma, na které lze nakonfigurovat definici cíle pro analýzu.  
Analyzovat > Adresář Můžete zadat absolutní cestu k adresáři obsahujícímu balíky. prázdný
Analyzovat > Procházet... Umožňuje vám procházením vyhledat složku balíků pro analýzu.  
Analyzovat > Generovat sestavu HTML pro stávající procházení použití Umožňuje vám vytvořit sestavu pro stávající procházení bez nutnosti opakování analýzy.  
Vyhledat > Odkazy na Umožňuje vám určit název (nebo odpovídající regulární výraz) balíku, chcete-li zobrazit odkazy na něj směřující. Podívejte se na následující příklad: org\.eclipse.*. V tomto příkladu uvádíme, že chceme zobrazit všechny odkazy na libovolný balík, který začíná názvem org.eclipse.. prázdný
Vyhledat > Odkazy na rozhraní API Umožňuje vám procházením vyhledávat odkazy na rozhraní API. nezaškrtnuto
Vyhledat > Interní odkazy Umožňuje vám procházením vyhledávat interní odkazy. zaškrtnuto
Vyhledat > Nepovolené použití rozhraní API Umožňuje vám procházením vyhledávat nepovolené použití rozhraní API, to znamená použití omezených členů rozhraní API. nezaškrtnuto
Hledat v > Odpovídající balíky Umožňuje vám zadat název (nebo odpovídající regulární výraz) balíku(ů), chcete-li nalézt odkazy, které z tohoto balíku vedou, to znamená rozsah hledání. Podívejte se na následující příklad: .*. V tomto příkladu uvádíme, že chceme prohledat všechny balíky, jejichž název se shoduje s libovolnou posloupností znaků. Stejného efektu lze dosáhnout tím, že pole ponecháte nevyplněné. prázdný
Tvorba sestav > Typ sestavy Umožňuje zvolit jeden ze dvou formátů sestavy html. Je-li vybrána volba Sestava odkazovaných balíků (Producenti), sestava vypíše všechny balíky obsahující typy, na které se odkazuje v prohledávaných balících. Je-li vybrána volba Odkazování sestavy balíků (Spotřebitelé), sestava bude uspořádána tak, že zobrazí všechny balíky v rozsahu hledání, které obsahují odkazy.

Při přepínání typů sestav zkontrolujte, zda mají regulární výrazy Odkazy na a Porovnávání balíků správné hodnoty. Při použití výrazů se zástupnými znaky, jako např. .*, v jednom nastavení, je často při přepnutí na jiný typ sestavy třeba přesunout zástupný znak do druhého nastavení, aby byla získaná sestava co nejužitečnější.

Sestava odkazovaných balíků (Producenti)
Tvorba sestav > Umístění výstupu sestavy Umožňuje vám zadat absolutní cestu k umístění, do kterého se mají umístit všechny vygenerované sestavy. prázdný
Tvorba sestav > Procházet... Umožňuje vám vybrat si umístění pro výstup všech sestav.  
Tvorba sestav > Vyčistit adresář sestav před vytvořením nových sestav výsledků. Umožňuje vám vyčistit existující umístění sestav XML před procházením vytvářejícím sestavu jakýchkoli výsledků. Je třeba poznamenat, že tato volba úplně odebere určený adresář sestav, pokud existuje, a to včetně všech podřízených adresářů, které jsou také rekurzivně odebrány. nezaškrtnuto
Tvorba sestav > Vytvořit sestavy HTML Převede celý výstup XML do formátovaného HTML a umístí jej do umístění <report location>\html. nezaškrtnuto
Tvorba sestav > Vyčistit umístění sestav HTML Umožňuje vám vyčistit existující umístění HTML před vytvořením nových sestav. Je třeba poznamenat, že tato volba úplně odebere určený adresář HTML, pokud existuje, a to včetně všech podřízených adresářů, které jsou také rekurzivně odebrány. Tato volba je povolena pouze, pokud vyberete volbu Vytvořit sestavy HTML, která je uvedena výše. nezaškrtnuto
Tvorba sestav > Otevřít sestavu po dokončení hledání Otevře sestavu HTML po dokončení analýzy. Tato volba je povolena pouze, pokud vyberete volbu Vytvořit sestavy HTML, která je uvedena výše. nezaškrtnuto
Tvorba sestav > Popis Umožňuje vám zadat popis čitelný pro člověka pro danou sestavu. prázdný

Karta Vzory

Karta Vzory vám umožňuje vytvářet různé druhy vzorů regulárních výrazů pro řízení analýzy použití. Momentálně existují tři podporované druhy vzorů:

  1. Vzor archivu - Umožňuje určit vnořené archivy, které by měly být během analýzy ignorovány.
  2. Vzor balíku - Umožňuje určit balíky, které mohou být interní nebo API, bez nutnosti aktualizovat soubor typu manifest balíku.
  3. Vzor převodu sestavy - Umožňuje vytvořit regulární výraz názvu balíku pro filtrování odkazů v sestavě. Všechny odkazy v sestavě jsou filtrovány pomocí úplného názvu balíku.

Karta Šablony


Volba

Popis

Výchozí

Přidat... Umožňuje přidat nový vzor. Toto tlačítko spustí Průvodce vzory.  
Upravit Umožňuje úpravu aktuálně vybraného vzoru. V daný okamžik lze upravovat pouze jeden vzor.  
Odebrat Umožňuje odebrat vybrané vzory. Je možné odebrat více vzorů najednou.  

Související úlohy

Porovnání s úrovní baseline rozhraní API
Nastavení úrovně baseline

Související odkazy

Předvolby úrovní baseline rozhraní API
Průvodce vzory použití rozhraní API