3. Tworzenie własnej dokumentacji
3.5. Tagi plików
3.4.15. Zaawansowane użycie
« Poprzedni
4. TypeFriendly
Następny »

3.5. Tagi plików

W rozdziale tym opisane są wszystkie dostępne tagi, jakich można używać w plikach rozdziałów. Większość z nich przyjmuje wartość tekstową, lecz niektóre mogą także obsługiwać zespół wartości (tablicę), którą podajemy w następujący sposób:

NazwaTagu:
 - Wartość 1
 - Wartość 2
 - Wartość 3

Pola podstawowe

Title
pełny tytuł danego rozdziału
ShortTitle
skrócony tytuł rozdziału (np. na potrzeby odnośników). Jeżeli nie jest ustawiony, brana jest wartość z Title.
SeeAlso
tablica identyfikatorów rozdziałów na potrzeby rubryki "Zobacz także".
SeeAlsoExternal
jak wyżej, lecz umożliwia podanie zewnętrznych odnośników. Po spacji można wpisać tekst odnośnika
Status
wyświetla pod tytułem pole o tytule "Status", które można zaadaptować do dowolnych celów.
Reference
umożliwia podanie sposobu wywołania funkcji (liczba, typ parametrów, zwracana wartość itd.).
Author
autor dokumentu
VersionSince
od jakiej wersji dany element jest dostępny
VersionTo
do jakiej wersji dany element był dostępny

Przykład:

Title: Funkcja foo()
ShortTitle: foo()
Reference: void foo(int $a, int $b)
VersionSince: 1.0.0
VersionTo: 1.2.0
SeeAlso:
 - reference.functions.bar
 SeeAlsoExternal:
 - http://www.example.com/ Przykładowa strona

Programowanie obiektowe

Pola te służą do łatwiejszego tworzenia dokumentacji do obiektowego kodu. Umożliwiają określenie np. klas pochodnych, bazowych itd. Wszędzie TypeFriendly zakłada, że otrzyma identyfikator rozdziału, który opisuje daną rzecz:

Extends
klasa bazowa.
Implements
implementowane interfejsy.
ExtendedBy
lista klas rozszerzających aktualną.

Przykładowe użycie:

Title: Klasa "foo"
Extends: reference.bar
Implements:
 - reference.foo-interface
 - reference.bar-interface
ExtendedBy:
 - reference.joe

Dodatkowo istnieją wersje tych dyrektyw, które umożliwiają podanie nazwy klasy bezpośrednio. Wszystkie one mają nazwy rozpoczynające się od dużej litery "E", np. EExtends, EImplements. Przykładowe użycie:

Title: Klasa "foo"
EExtends: PDO
EImplements:
 - Countable
 - IteratorAggregate

Pola planowane

Poniższe pola są propozycjami, które prawdopodobnie zostaną wdrożone w nadchodzących wersjach.

MultiExtends
do obsługi wielokrotnego dziedziczenia
SeeAlsoExternal
sekcja "Zobacz także", lecz z odnośnikami zewnętrznymi
Quote
umożliwi wklejenie cytatu na początek rozdziału
QuoteAuthor
autorstwo cytatu
AllowUserComments
do generatora wersji on-line: informacja, czy zezwolić na komentowanie danego rozdziału.
Appendix
doklei do nazwy podstrony słowa "Dodatek X.", gdzie X to litera podana za wartość.
3.5. Tagi plików
3. Tworzenie własnej dokumentacji
« Poprzedni
3.4.15. Zaawansowane użycie
Następny »
4. TypeFriendly