rdoc2.3 — Online w chmurze

PROGRAM:

IMIĘ

rdoc2.3 - Generuj dokumentację z plików skryptów Ruby

STRESZCZENIE

rdoc2.3 [opcje] [nazwy...]

OPIS

Pliki są analizowane, a zawarte w nich informacje zbierane, zanim zostaną wygenerowane jakiekolwiek dane wyjściowe
wytworzony. Umożliwia to rozwiązanie powiązań między wszystkimi plikami. Jeśli imię to
katalog, jest on przeglądany. Jeśli nie określono żadnych nazw, wszystkie pliki Ruby w bieżącym
przetwarzane są katalogi (i podkatalogi).

Dostępne formatery wyjściowe: chm, html, ri, xml

Aby uzyskać informacje o tym, dokąd trafiają dane wyjściowe, użyj:
rdoc --help-output

OPCJE

--akcesor, -A nazwa akcesorium [,..]
oddzielona przecinkami lista dodatkowych metod klas, które powinny być traktowane podobnie
„attr_reader” i przyjaciele. Opcja może się powtórzyć. Każda nazwa akcesorium może mieć
Dołączono „=tekst”, w którym to przypadku tekst ten pojawia się w miejscu r/w/rw
zwykłe akcesoria.

--wszystko, -a
uwzględnij wszystkie metody (nie tylko publiczne) w wynikach.

--zestaw znaków, -c charset
określa zestaw znaków HTML

--odpluskwić, -D
wyświetla wiele informacji wewnętrznych

--diagram, -d
generuj diagramy przedstawiające moduły i klasy. Aby skorzystać z tej funkcji, potrzebujesz wersji 1.8.6 lub nowszej
opcję --diagram poprawnie. Kropka jest dostępna od
<URL:http://www.research.att.com/sw/tools/graphviz/>.

--wykluczać, -x wzorzec
nie przetwarzaj plików ani katalogów pasujących do wzorca. Pliki podane wyraźnie na
wiersz poleceń nigdy nie zostanie wykluczony.

--rozszerzenie, -E nowa = stary
traktuj pliki kończące się na .new tak, jakby kończyły się na .old. Użycie „-E cgi=rb” spowoduje
powoduje, że xxx.cgi zostanie przeanalizowany jako plik Ruby

--skrzynki plików, -F
klasy są umieszczane w polach reprezentujących pliki, w których znajdują się te klasy.
Klasy współdzielone pomiędzy więcej niż jednym plikiem są pokazane wraz z listą współdzielonych plików
ich. Cicho odrzucane, jeśli nie podano --diagram. Eksperymentalne.

--fmt, -f nazwaformatu
ustaw formater wyjściowy (patrz poniżej).

--Wsparcie, -h
wykorzystanie druku.

--wyjście pomocy, -O
wyjaśnić różne opcje wyjściowe.

--format obrazu, -I gif|png|jpg|jpeg
ustawia format obrazu wyjściowego dla diagramów. Może mieć format png, gif, jpeg, jpg. Jeśli ta opcja
jest pominięty, używany jest png. Wymaga --diagramu.

--włączać, -i reż. [, reż....]
ustaw (lub dodaj do) listę katalogów, które mają być przeszukiwane, jeśli spełniasz wymagania :include:
upraszanie. Można użyć więcej niż raz.

--źródło wbudowane, -S
pokaż kod źródłowy metody bezpośrednio, a nie poprzez wyskakujące łącze.

--Numery linii, -N
uwzględnić numery linii w kodzie źródłowym

--główny, -m Nazwa
nazwa będzie początkową wyświetlaną stroną.

--łączyć, -M
podczas tworzenia wyjścia ri łącz przetworzone klasy w wcześniej udokumentowane klasy
imienia imienia.

--jeden plik, -1
umieść wszystkie dane wyjściowe w jednym pliku.

--op, -o reż
ustaw katalog wyjściowy.

--nazwa_opcji, -n Nazwa
ustaw nazwę wyjścia. Nie ma wpływu na HTML.

--bezładny, -p
Podczas dokumentowania pliku zawierającego moduł lub klasę zdefiniowaną również w other
files, pokaż wszystkie elementy tego modułu/klasy na każdej stronie plików. Domyślnie tylko
pokaż rzeczy zdefiniowane w tym konkretnym pliku.

--cichy, -q
nie pokazuj postępu podczas analizy.

--ri, -r
generuje dane wyjściowe do wykorzystania przez „ri”. Pliki są przechowywane w katalogu „.rdoc”.
w katalogu domowym, chyba że zostanie on zastąpiony przez kolejny parametr --op, więc nie
potrzebne są specjalne uprawnienia.

--ri-site, -R
generuje dane wyjściowe do wykorzystania przez „ri”. Pliki są przechowywane w katalogu obejmującym całą witrynę,
udostępnienie ich innym, dlatego potrzebne są specjalne przywileje.

--ri-system, -Y
generuje dane wyjściowe do wykorzystania przez „ri”. Pliki są przechowywane w katalogu na poziomie systemu,
udostępnienie ich innym, dlatego potrzebne są specjalne przywileje. Ta opcja jest
przeznaczony do użycia podczas instalacji Ruby.

--show-hash, -H
nazwa formularza #name w komentarzu jest możliwym hiperłączem do metody instancji
nazwa. Po wyświetleniu znak „#” jest usuwany, chyba że określono tę opcję.

--styl, -s url arkusza stylów
określa adres URL osobnego arkusza stylów.

--szerokość tabulatora, -w n
ustaw szerokość znaków tabulacji (domyślnie 8).

--szablon, -T nazwa-szablonu
ustaw szablon używany podczas generowania danych wyjściowych.

--tytuł, -t XNUMX
ustaw tekst jako tytuł wyniku.

--wersja, -v
wyświetl wersję RDoc.

--cvs internetowe, -W url
określ adres URL połączenia z interfejsem internetowym do CVS. Jeśli adres URL zawiera znak a
'%s', nazwa pliku zostanie do niego dołączona.

Lipiec 2014 RDOC2.3(1)

Korzystaj z rdoc2.3 online, korzystając z usług onworks.net