Tworzenie wykazu dokumentów

Tworzenie wykazu do dokumentacji

Cudem technologicznym, który w moim przekonaniu zrewolucjonizuje udzielanie odpowiedzi na forum jest znacznik [doc_rel] dzięki któremu możemy minimalnym nakładem udzielić wyczerpującej odpowiedzi użytkownikowi jakiej funkcji należy użyć i co ona robi. Załóżmy więc, że problemem jest konwersja łańcucha znaków na liczbę. Najkrótszą odpowiedzią pomocą, jaką można w tym momencie udzielić to zapisanie [doc_rel list="237,238,239,242"]. Efekt niniejszego wiersza będzie następujący:

Konwersja na liczbę	Funkcje do konwersji łańcucha znaków do postaci liczbowej. (kategoria)
atof	Konwertuje wartość zapisaną w łańcuchu znaków do postaci liczby zmiennoprzecinkowej (double). (funkcja)
atoi	Konwertuje wartość zapisaną w łańcuchu znaków do postaci liczby typu całkowitego (int). (funkcja)
atol	Konwertuje wartość zapisaną w łańcuchu znaków do postaci liczby typu całkowitego (long). (funkcja)

Pisząc dokumentację mimo wszystko wykorzystujemy tą funkcjonalność na dwa sposoby. Pierwszym z nich jest listowanie metod klas/szablonów i można zobaczyć to w dokumencie _{» standard C++ ♦} allocator.

Drugie zastosowanie, od którego zrodził się w sumie pomysł znacznika [doc_rel] jest sekcja Zagadnienia powiązane, której przykład można zobaczyć w dokumencie _{» standard C ♦} isdigit.

Inne wykazy

Pozostałymi wykazami, jakie zostały oprogramowane i działają analogicznie do [doc_rel] są [tut_rel] oraz [art_rel]. [tut_rel] służy do tworzenia wykazów z działu kursów, natomiast [art_rel] z działu artykułów.

Zasady działania wszystkich znaczników wymienionych w niniejszym dokumencie są takie same.

Parametr header

Jeżeli chcemy wyświetlać belkę tytułową, która informuje o pochodzeniu wylistowanych dokumentów należy dodać parametr header w następujący sposób: [doc_rel list="237,238,239,242" header]. W efekcie uzyskamy następującą listę:

Dokumentacja
Konwersja na liczbę	Funkcje do konwersji łańcucha znaków do postaci liczbowej. (kategoria)
atof	Konwertuje wartość zapisaną w łańcuchu znaków do postaci liczby zmiennoprzecinkowej (double). (funkcja)
atoi	Konwertuje wartość zapisaną w łańcuchu znaków do postaci liczby typu całkowitego (int). (funkcja)
atol	Konwertuje wartość zapisaną w łańcuchu znaków do postaci liczby typu całkowitego (long). (funkcja)

Powyższa własność działa dla każdego znacznika omówionego w niniejszym dokumencie.