A dokumentáció felépítése

A lap tetején látható navigációs menü elemei:

Áttekintés

Ez a dokumentációt nyitó kezdő áttekintő oldal a csomagok listájával.

Csomag

Minden csomag bemutatása külön oldalon történik. Szintén itt látható a csomag következő elemeinek összefoglaló listája:

• Interfészek (dőlt betűvel)
• Osztályok
• Felsorolási típusok
• Kivételek
• Hibák
• Annotációs típusok

Típus

Minden típus ismertetése külön lapon történik. Egy oldal három részre osztható: rövid leírás, összefoglaló táblázatok, majd ezután következik az összetevők részletezése:

• Öröklési diagramm
• Közvetlen leszármazottak
• Kiterjesztett interfészek
• Megvalósító osztályok
• A típus deklarációja
• A típus leírása

• Beágyazott típusok
• Mezők
• Konstruktorok
• Metódusok

• Mezők részletezése
• Konstruktorok részletezése
• Metódusok részletezése

Az összefoglalásokban a részletes ismertetéseknek csak az első mondata jelenik meg. Míg az összefoglaló lista a betürendet követi, a részletezés a forrásfájl tartalma alapján történik, megtartva így a programozó által definiált logikai sorrendet.

Annotációs típus

Az annotációs típusok ismertetése külön oldalon, a következő formában történik:

• Az annotációs típus deklarációja
• Az annotációs típus leírása
• Kötelező adatmezők
• Opcionális adatmezők
• Adatmezők részletezése

Felsorolási típus

A felsorolási típusok ismertetése külön oldalon, a következő formában történik:

• A felsorolási típus deklarációja
• A felsorolási típus leírása
• Felsorolt értékek
• Felsorolt értékek részletezése

Hivatkozás

Ezen oldal az aktuális elemre történő hivatkozásokat tárgyalja. Típusok esetén például itt összefoglalásra kerülnek az adott típus specializációi, ilyen típussal deklarált mezők, metódusok ezzel a visszatérési értékkel, valamint ilyen típusú paramétereket váró metódusok és konstruktorok.

Hierarchia

Hierarchiás összefoglalást csomagonként, vagy az összes csomagra értve is kérhetük. A hierarchia szerkezete az öröklési / kiterjesztési relációnak felel meg.

• Az áttekintő kezdőoldalról elérve az összes csomag hierarchiája megtekinthető.
• Csomagszinten csak az adott csomag hierarchiája fog megjelenni.

Index

A dokumentált elemek tárgymutatóját tartalmazza ABC sorrendben.

ELŐZŐ / KÖVETKEZŐ

Az aktuális elem szintjén navigálhatunk vele oda/vissza.

MEGOSZTVA / EGY LAPON

A böngészőablak megosztását lehet vele szabályozni.

Szerializált forma

Szerializálható típusok adatainak leírása. Ez az ismertető közvetlenül nem, csak a szerializálható típusok leírásából érhető el.

Konstans mezőértékek

A konstansok neveit és értékeit mutatja.