cxref - Online w chmurze

PROGRAM:

IMIĘ

cxref - narzędzie do tworzenia odsyłaczy i dokumentacji w języku C.

STRESZCZENIE

cxref filename [ ... Nazwa pliku] [-Odirname] [-Nnazwa podstawowa] [-Rnazwa podstawowa] [-wszystkie-komentarze]
[-bez-komentarzy] [-dosłowne-komentarze] [-blok-komentarze]
[-xref[-all][-plik][-funkcja][-zmienna][-typ]] [-warn[-all][-comment][-xref]]
[-indeks[-wszystko][-plik][-funkcja][-zmienna][-typ]] [-surowy] [-lateks] [-html[-źródło]] [-rtf] [-sgml]
[-Idirname] [-Dokreślić] [-Uokreślić] [-CPP [program_cpp] [-- cpp_args ... [argumenty_cpp]

cxref filename [ ... Nazwa pliku] -kasować [-Odirname] [-Nnazwa podstawowa] [-Rnazwa podstawowa]

OPIS

Program, który może automatycznie generować dokumentację i odnośniki dla języka C
program.

Dane wejściowe to dowolny program w języku C z odpowiednimi komentarzami, a dane wyjściowe to LaTeX, HTML, RTF lub
Pliki SGML.

OPCJE

filename
Nazwa pliku do udokumentowania. Jednocześnie można dokumentować dowolną liczbę plików.

-kasować
Podane pliki mają zostać usunięte z katalogu wyjściowego, a ich wpisy w nim zawarte
baza danych odniesień krzyżowych i główne pliki wyjściowe mają zostać usunięte.

-Imię
Nazwa katalogu, w którym mają być przechowywane pliki wyjściowe LaTeX oraz ich lokalizacja
pliki odniesień krzyżowych, które są tworzone.

-Nnazwa_bazy
Nazwa, której należy używać w pierwszej części plików wyjściowych i plików odniesień krzyżowych
w przypadku cxref rozszerzenia plików pozostają takie same.

-NazwaRdir
Jeżeli pliki źródłowe znajdują się w więcej niż jednym katalogu, ustaw dirname na nazwę
katalog główny drzewa źródłowego (jeśli jest łatwiej, użyj ścieżki względnej, np. `-R../..”).
Spowoduje to uruchomienie cxref z tego katalogu głównego, a `-Odirname' musi być
względem tego katalogu.

-wszystkie-komentarze
W przypadku, gdy uważasz, że istniejące komentarze mogą działać (opis znajdziesz powyżej)
specjalnych komentarzy). [Niebezpieczeństwo! Ta opcja może dawać dziwne rezultaty.]

-bez-komentarzy
Ignoruje wszystkie komentarze, przydatne, jeśli chcesz zobaczyć tylko odniesienia krzyżowe, a nie
dokumentacja.

-dosłowne-komentarze
Gdy komentarze, które masz w kodzie, są sformatowane w ustalonym stylu
które chcesz zachować na wyjściu, ta opcja wymusi ich nieumieszczanie
sformatowano ponownie. [Uwaga, dotyczy to tylko komentarzy dotyczących plików i funkcji.]

-blok-komentarze
Gdy komentarze w programie są sformatowane w stylu „blokowym” (z wiodącym znakiem
(jeśli w każdym wierszu znajduje się znak „*”), ta opcja usunie ten znak z
wyjście. [Działa dla pojedynczego `*', `+', `|' lub `:' w każdym wierszu.]

-odnośnik Przygotuj informacje o odsyłaczach (patrz poniżej).
-all Wszystkie odsyłacze.
-file Odsyłacze do plików.
-func Odsyłacze do funkcji.
-var Odsyłacze dla zmiennych.
-type Odsyłacze do typów.

-ostrzegać Aby wygenerować ostrzeżenia, opcje muszą być ze sobą połączone:
-all Wszystkie ostrzeżenia.
-komentarz Ostrzegaj przed brakującymi komentarzami.
-xref Ostrzegaj przed brakującymi odniesieniami krzyżowymi.

-indeks Utwórz indeks odniesień krzyżowych, opcje muszą być ze sobą połączone:
-all Wszystkie indeksy.
-file Indeks plików.
-func Indeks funkcji.
-var Indeks zmiennych.
-type Indeks typów.

-surowy Generuje surową formę wyjścia, która nie jest specjalnie przydatna, chyba że użyjesz opcji -warn.

-lateks Utwórz plik LaTeX, aby udokumentować każdy z plików źródłowych, a także dodatkowy plik
która zawiera każdy z tych plików.

-html Utwórz plik HTML 4.01, aby udokumentować każdy z plików źródłowych i plik główny, aby
odnieś się do każdego z tych plików.

-źródło html
Utwórz plik wyjściowy HTML oraz wersję HTML pliku źródłowego z linkami do niego.

-rtf Utwórz plik w formacie Rich Text Format (RTF) w celu udokumentowania pliku źródłowego.

-sgml Utwórz plik SGML dokumentujący plik źródłowy. (Używając DTD LinuxDoc).

-Imię imienia
Opcja GCC określająca ścieżkę do plików dołączonych.

-Ddefiniuj
Opcja GCC definiująca symbol preprocesora.

-Definicja
Opcja GCC umożliwiająca usunięcie definicji symbolu preprocesora.

-CPP program
Nazwa programu, który ma zostać użyty zamiast domyślnej nazwy w czasie kompilacji. Program
musi być w stanie wykonać wszystkie akcje, które `gcc -E -C -dD' wykonuje, aby działać. Jeśli
program przyjmuje argumenty, więc całość musi być w cudzysłowie, aby
jest interpretowany jako pojedynczy argument dla cxref.

--arg ... arg
Dodatkowe argumenty, które mają zostać przekazane preprocesorowi, można umieścić po `--'
separator.

C kompilator Wymiana cxref-cc
Aby uprościć korzystanie z cxref w istniejącym kodzie źródłowym, dostępny jest teraz skrypt powłoki, który
wywołaj kompilator C, a następnie wywołaj cxref, aby przetworzyć plik źródłowy. Oznacza to, że
można go używać jako zamiennika CC w plikach Makefiles i tym podobnych.

Użycie: cxref-cc [zwykłe opcje cc]

Nazwa pliku źródłowego jest wyodrębniana z listy opcji, podobnie jak `-D*',
Flagi `-I*', `-U*' i gdy kompilator C zakończy działanie pomyślnie, zostanie wywołane cxref.
nazwa kompilatora C, który ma zostać użyty, jest kontrolowana przez zmienną środowiskową CXREFCC lub jeśli
jeśli nie jest ustawiona, to jest to zmienna środowiskowa CC, a jeśli nie, to po prostu gcc.

Użycie tego skryptu wymaga użycia pliku konfiguracyjnego `.cxref' zawierającego opcje
ponieważ nie ma gdzie umieścić opcji w wierszu poleceń kompilatora C.

Spowoduje to jedynie odniesienia krzyżowe i udokumentowanie plików źródłowych C, ponieważ są one jedynymi
te, które są kompilowane, ale upewni się, że są one wzajemnie powiązane z
poprawne opcje itp.

Odnośnik Konfiguracja filet
Te argumenty wiersza poleceń można również umieścić w pliku o nazwie `.cxref' zamiast
wiersz poleceń. Gdy cxref jest uruchamiany, argumenty programu są interpretowane w
następujące zamówienie.

(1) Te w wierszu poleceń. (2) Te w pliku `.cxref' w bieżącym katalogu.
(3) Te w pliku `.cxref' w korzeniu drzewa źródłowego określonym przez `-R'.

Oznacza to, że w drzewie źródłowym obejmującym wiele katalogów każdy podkatalog może mieć plik `.cxref'
plik zawierający tylko linię `-R..' lub odpowiednią. Główny katalog może mieć
Plik `.cxref' zawierający pozostałe opcje. To całkowicie eliminuje potrzebę
mieć jakiekolwiek opcje w wierszu poleceń oprócz nazw plików źródłowych.

Format pliku `.cxref' to dowolna liczba wierszy, z których każdy zawiera pojedynczy
argument wiersza poleceń (równoważny jednemu z argv). Jedyne opcje, których nie można
używane są nazwy samych plików źródłowych i opcja `-delete'. Puste linie są
ignorowane, a linie zaczynające się od znaku '#' są komentarzami.

Program Dokumenty Komentarze
Dokumentacja programu jest tworzona na podstawie komentarzy w kodzie, które są
odpowiednio sformatowane. Odwołanie krzyżowe pochodzi z samego kodu i nie wymaga
dodatkowa praca.

Komentarze specjalne to `/**** ****/' (dla pliku) i `/*++++ ++++*/' (dla danych)
obiekt) można użyć dowolnej liczby znaków `*' lub `+' wewnątrz standardowych komentarzy `/*' i `*/'
ograniczniki w komentarzach są ignorowane.

Jeżeli wiersz komentarza zaczyna się od spacji i następuje po nim `+html+', to reszta
linia jest uwzględniana tylko w wynikach HTML i nie jest przetwarzana, aby mogła zawierać HTML
znacznik `-html-' oznacza, że ​​reszta wiersza jest zawarta we wszystkich oprócz HTML
wyjście. To samo dotyczy innych formatów wyjściowych, `+none+' można użyć dla linii
nie pojawiać się w żadnym wyjściu. Wyjątkiem od tej reguły jest to, że surowe wyjście nie robi nic
sprawdzając i wypisując wszystkie wiersze.

W każdej sytuacji, w której komentarz następuje po znakach `,', `;' lub `)' rozdzielonych wyłącznie spacjami i
zakładki, komentarz jest umieszczany przed znakiem interpunkcyjnym, aby zastosować go do obiektu tam znajdującego się.

Program został zaimplementowany przy użyciu pełnego parsera gramatyki ANSI C z kilkoma rozszerzeniami GCC,
oznacza to, że styl kodu nie ma znaczenia, liczy się tylko jego treść i komentarze.

Krzyż Odniesienia
Odniesienia krzyżowe wykonuje się dla następujących elementów

Akta
Pliki, w których znajduje się bieżący plik
(nawet jeśli dołączone poprzez inne pliki).

#zawiera
Pliki zawarte w bieżącym pliku.
Pliki zawarte w tych plikach itp.

Zmienne
Miejsce definicji zmiennych zewnętrznych.
Pliki, które mają widoczność zmiennych globalnych.
Pliki/funkcje używające zmiennej.

Funkcje
Plik, w którym znajduje się prototyp funkcji.
Funkcje, które funkcja wywołuje.
Funkcje wywołujące funkcję.
Pliki i funkcje odwołujące się do funkcji.
Zmienne używane w funkcji.

Każdy z tych elementów jest odniesiony do innego w wynikach.

Odwoływanie się do plików używa plików `cxref.variable', `cxref.function', `cxref.include' i
`cxref.typedef' w katalogu wyjściowym. To kompletna lista funkcji i
zmiennego użycia w programie i może być użyte do wygenerowania hierarchii wywołań funkcji lub
na przykład diagram użycia zmiennej. Potrzebne są dwa przebiegi cxref każdego pliku, pierwszy do
utworzyć pliki odsyłaczy i po drugie z nich korzystać.

(Nazwy plików będą inne, jeśli użyto opcji `-N'.)

Lateks Wydajność
Domyślnym wyjściem LaTeX jest plik dla każdego z plików źródłowych z jednym dodatkowym plikiem
`cxref.tex', który zawiera każdy z pozostałych plików. Ma to na celu umożliwienie plikowi makefile tylko
zaktualizuj zmienione pliki (chociaż odniesienia mogą wymagać, aby wszystkie pliki były
ponownie sprawdzone). Po zapisaniu pliku cxref.tex może on zostać zmodyfikowany przez użytkownika,
wszystkie nowe pliki, które są dodawane, są dodawane na końcu sekcji kodu źródłowego, reszta
plik pozostaje niezmieniony.

Indeks jest zapisywany do pliku o nazwie `cxref.apdx.tex', a plik cxref.tex jest aktualizowany w celu odwołania się do niego.
do niego.

Wypisano także trzy pliki stylów LaTeX: `page.sty', `fonts.sty' i `cxref.sty'.
Konfigurują one stronę tak, aby używała mniejszego marginesu i mniejszej czcionki, aby umożliwić wyświetlenie większej ilości tekstu.
stronę i zdefiniować nowe polecenia do składu danych wyjściowych cxref.

(Nazwy plików `cxref.tex' i `cxref.apdx.tex' są różne, jeśli wybrano opcję `-N'
używany.)

HTML Wydajność
Domyślny wynik HTML to plik dla każdego z plików źródłowych z jednym dodatkowym plikiem
`cxref.html', który zawiera każdy z pozostałych plików. Ma to na celu umożliwienie plikowi makefile tylko
zaktualizuj zmienione pliki (chociaż odniesienia mogą wymagać, aby wszystkie pliki były
ponownie sprawdzone). Po zapisaniu pliku cxref.html może on zostać zmodyfikowany przez użytkownika,
wszystkie nowe pliki, które są dodawane, są dodawane na końcu przed spisem treści, reszta
pliku, który nie uległ zmianie.

Indeks jest zapisywany do pliku o nazwie `cxref.apdx.html', a plik cxref.html jest aktualizowany w celu odwołania się do niego.
do niego.

(Nazwy plików `cxref.html' i `cxref.apdx.html' są różne, jeśli wybrano opcję `-N'
używany.)

Wyjście HTML korzysta ze standardu HTML 4.01, a wszystkie strony są poprawnie walidowane.

RTF Wydajność
Rich Text Format to dość niski format opisu strony opracowany przez Microsoft.
nie jest to dobrze zdefiniowany i łatwy do zrozumienia standard, jak inne formaty, ale jest
popularne w wymianie dokumentów.

Dla każdego pliku źródłowego istnieje pojedynczy plik wyjściowy i plik indeksu.

SGML Wydajność
Ponieważ SGML jest metajęzykiem, konieczne jest zdefiniowanie elementów układu, a także
podaj informacje. Wyjście cxref używa formatu dokumentu LinuxDoc i jest
przeznaczony do użytku z programami SGMLtools (http://www.sgmltools.org/).

Dla każdego pliku źródłowego istnieje pojedynczy plik wyjściowy i plik indeksu.

Użyj cxref online za pomocą usług onworks.net