RDoc

rdoc składa się z dwóch głównych części.

Jednym z nich jest rdoc , narzędzie do generowania dokumentacji HTML. Drugim jest ri , narzędzie do tworzenia dokumentacji dla interfejsu wiersza poleceń Ruby.

Aby móc prawidłowo używać rdoc, deweloper musi zmienić sposób dodaje komentarze do jego kodu źródłowego.

rdoc korzysta z określonego źródła komentarzach Kod strukturę, dzięki czemu mogą one być łatwo wyodrębnione i pomoże wypełnić stronę dokumentacji.

Komentarz struktura rdoc jest bardzo udane, są wykorzystywane przez wielu podobnych generatorów dokumentacji tworzonych w innych językach programowania

Co nowego w tej wersji.

• rdoc może teraz produkować pliki z tłumaczeniami do użytku z gettext.

Co nowego w wersji 4.2.0:

• rdoc może teraz produkować pliki z tłumaczeniami do użytku z gettext .

Co nowego w wersji 4.1.0.

• Ułatwienia dostępu wyjścia HTML
• Wygląd rdoc został zaktualizowany.

Co nowego w wersji 4.0.0.

• Dodane Markdown w obsługiwanym formacie
• ri mogą teraz pokazać stron (README itp.).
• Usunięto z rdoc stan globalny. Rdoc :: Sklep posiada drzewa dokumentacji i łączy sterownik do analizatorów i generatora.

Co nowego w wersji 3.12:

• Drobne usprawnienia:
• Dokument Dodany DEVELOPERS które zawiera przegląd jak działa rdoc i jak dodać nowe funkcje do rdoc.
• Poprawiono tytuł wyjścia HTML zawierać --title w elemencie tytułowej.
• rdoc --pipe teraz rozumie --markup.
• rdoc obsługuje IRC-Scheme hiperłączy.
• Poprawki błędów:
• Poprawiono tytuł na wyjściu HTML stron.
• Naprawiono parsowanie non-wcięte heredoc.
• Naprawiono parsowanie% wag [] i inne literały%.
• wymiana strzałka Poprawiono produkcji HTML munging operatora statku kosmicznego.
• Verbatim sekcje ERB pasujących do białej listy kodu Ruby nie są już podświetlaniem składni.
• zakończenia linii na okna są znormalizowane natychmiast po przeczytaniu z BINMODE.
• rdoc lepiej rozumie dyrektyw w komentarzach. Dyrektywy Komentarz można teraz znaleźć w dowolnym miejscu w komentarzach multi-line.
• Schludne linki do metod ponownie pokazać etykietę.
• rdoc :: Parser :: C mogą teraz znaleźć komentarzy bezpośrednio nad rb_define_class_under.
• W rdoc, backspace i ANSI formatujących, etykiety i notatki bez ciał są teraz widoczne.
• W rdoc, backspace i ANSI formatujących, spacje między etykietą lub notatki i jelita grubego jest obecnie pozbawiony.

Co nowego w wersji 3.11:

• Poprawki błędów:
• Unikaj parsowania plików TAGI zawarte w perełek.

Co nowego w wersji 3.9.2:

• Bug fix:
• poluzowane TIDYLINK regexp, aby umożliwić dowolną treść w sekcji linków, takich jak: & # x3c; tt & # X3E; {foo} [rdoc-ref: SomeClass] & # x3c; / tt & # X3E;
• W pozycjach wyjściowych HTML są ograniczone do & # x3c; tt & # x3e; & # x3c H6; & # x3e; & # x3c; / tt & # X3E; ponownie.

Co nowego w wersji 3.9.1:

• Poprawki błędów:
• rdoc Fix :: Markup parser dla nagłówka, a następnie przez token nietekstowej.
• rdoc Fix :: Markup :: ToHtmlCrossref # gen_url za nieprzestrzeganie - & # x3c; tt & # X3E; rdoc-ref & # x3c; / tt & # X3E; linki.
• Fix bug report URL, gdy awarii rdoc.

Co nowego w wersji 3.8:

• Drobne usprawnienia:
• rdoc :: Parser :: C mogą teraz odkryć sposoby na ENV i argF.
• rdoc :: Parser :: C teraz wie o rb_cSocket i rb_mDL.
• Poprawki błędów:
• Aktualizacja obiektu w ri magazynu danych z nowych danych usuwa również metody, obejmuje stałe i aliasów.

Co nowego w wersji 3.7:

• Drobne usprawnienia:
• Nowa dyrektywa: kategoria: metody, która pozwala być zgrupowane w sekcje czyściej. Zobacz rdoc :: znaczników szczegółów.
• Dokument klasy dla rdoc :: Parser :: C obsługuje Foo :: CONST jak mech.
• Wyjście Metoda ri jest lista oddzielonych przecinkami, gdy wyświetlana interaktywnie.
• rdoc :: ClassModule # scalić teraz woli informację argumentu nad odbiornika (teraz zachowuje się jak Hash # scalić! Zamiast wstecznej krzyżyka # seryjnej!).
• rdoc :: znaczników # przekonwertować teraz akceptuje rdoc :: Markup :: instancji dokumentu
• rdoc obecnie posiada kod do generowania rdoc i danych ri kiedy perełki zainstalować
• Dodano rdoc :: rdoc :: zresetować
• Dodano rdoc :: CodeObject # nazwa_pliku
• Poprawki błędów:
• ri nie zawiesza się podczas próby do zakończenia zwykły
• rdoc :: Parser :: Ruby nie zjada treść kiedy zaczynają bloki = / = dokumentacji end są następnie udokumentowania pozycji. Wydanie # 41 KNU.
• rdoc :: Markup :: Formatowanie i podklasy umożliwiają teraz opcjonalny parametr znaczników + + do dodawania niestandardowych znaczników. Przykład w rdoc :: Markup :: Formatter będzie teraz działać.
• rdoc :: Parser :: C mogą rozróżniać metody klasy i metody instancji w dokumencie sposobem.
• rdoc teraz koduje nazwy plików w kodowaniu wyjściowego.
• generowania danych ri dla metody aliasów nie powiela klasę w #full_name