cxref — online w chmurze

PROGRAM:

IMIĘ

cxref — narzędzie do tworzenia odsyłaczy i dokumentowania w języku C.

STRESZCZENIE

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

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

OPIS

Program, który może automatycznie generować dokumentację i odsyłacze dla języka C
program.

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

OPCJE

filename
Nazwa pliku do udokumentowania, jednorazowo dokumentowana może być dowolna liczba plików.

-kasować
Wymienione pliki mają zostać usunięte z katalogu wyjściowego i ich wpisy w
baza danych odsyłaczy i główne pliki wyjściowe mają zostać usunięte.

-Imię
Nazwa katalogu, który ma być używany dla wyjściowych plików lateksowych oraz lokalizacja pliku
tworzonych plików odsyłaczy.

-Nnazwa_bazy
Zamiast tego nazwa używana dla pierwszej części danych wyjściowych i plików odsyłaczy
cxref rozszerzenia plików pozostają takie same.

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

-wszystkie-komentarze
Jeśli uważasz, że istniejące komentarze mogą zadziałać (patrz opis powyżej
specjalnych komentarzy). [Niebezpieczeństwo! Ta opcja może dawać dziwne rezultaty.]

-bez komentarza
Ignoruje wszystkie komentarze, przydatne, jeśli chcesz tylko odsyłacze, a nie
dokumentacja.

-dosłowne-komentarze
Kiedy komentarze, które masz w kodzie, są sformatowane we wcześniej określonym stylu
które chcesz zachować na wyjściu, ta opcja wymusi ich usunięcie
przeformatowany. [Uwaga, dotyczy to tylko komentarzy do plików i funkcji.]

-blokuj-komentarze
Gdy komentarze w programie są sformatowane w stylu `blokowym' (z wiodącym
znak „*” w każdym wierszu), ta opcja usunie ten znak z pliku
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ć Wygeneruj ostrzeżenia, opcje muszą być ze sobą połączone:
-all Wszystkie ostrzeżenia.
-comment Ostrzega przed brakującymi komentarzami.
-xref Ostrzega o brakujących odsyłaczach.

-indeks Utwórz indeks odsyłaczy, opcje muszą być ze sobą połączone:
-all Wszystkie indeksy.
-file Indeks plików.
-func Indeks funkcji.
-var Indeks zmiennych.
-typ Indeks typów.

-surowy Stwórz surową formę wyjścia, tak naprawdę niezbyt użyteczną, z wyjątkiem opcji -warn.

-lateks Utwórz plik LaTeX, aby udokumentować każdy z plików źródłowych, a także dodatkowy plik
który 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
odwołać się do każdego z tych plików.

-html-src
Utwórz wyjście HTML i wersję HTML pliku źródłowego z linkami do niego.

-rtf Utwórz plik Rich Text Format (RTF), aby udokumentować plik źródłowy.

-sgml Utwórz plik SGML, aby udokumentować plik źródłowy. (Korzystając z LinuxDoc DTD).

-Imię imienia
Opcja GCC, aby określić ścieżkę dla dołączanych plików.

-Ddefiniuj
Opcja GCC do zdefiniowania symbolu preprocesora.

-Udefiniuj
Opcja GCC do niezdefiniowania symbolu preprocesora.

-CPP program
Nazwa programu, który ma być używany zamiast domyślnego czasu kompilacji. Program
musi być w stanie wykonać wszystkie akcje, które wykonuje `gcc -E -C -dD', aby zadziałało. Jeśli
program przyjmuje argumenty, to całość musi być ujęta w cudzysłowy, aby to zrobić
jest interpretowany jako pojedynczy argument do cxref.

--arg ... arg
Dodatkowe argumenty do przekazania do preprocesora można umieścić po `--'
separator.

C kompilator Wymiana cxref-cc
Aby uprościć korzystanie z cxref na istniejącym kodzie źródłowym, istnieje teraz skrypt powłoki, który to zrobi
wywołaj kompilator C, a następnie wywołaj cxref, aby przetworzyć plik źródłowy. Oznacza to, że to
może być używany jako zamiennik dla CC w plikach Makefile i tym podobnych.

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

Nazwa pliku źródłowego jest wyodrębniana z listy opcji, jak również z `-D*',
Flagi `-I*', `-U*' i gdy kompilator C pomyślnie zakończy działanie, zostanie wywołane cxref. The
nazwa używanego kompilatora C jest kontrolowana przez zmienną środowiskową CXREFCC lub if
to nie jest ustawione, a następnie zmienna środowiskowa CC lub w przeciwnym razie 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ń dla kompilatora C.

Spowoduje to tylko odniesienie i udokumentowanie plików źródłowych C, ponieważ są one jedynymi
te, które są skompilowane, ale upewni się, że są one powiązane z plikami
poprawne opcje itp.

Odnośnik systemu filet
Te argumenty wiersza poleceń można również umieścić w pliku o nazwie `.cxref' zamiast na
wiersz poleceń. Po uruchomieniu cxref argumenty programu są interpretowane w pliku
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 katalogu głównym drzewa określonym przez `-R'.

Oznacza to, że w wielokatalogowym drzewie źródłowym każdy podkatalog może mieć `.cxref'
plik zawierający tylko linię `-R..' lub odpowiednią. Główny katalog może mieć plik
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 linii, z których każda zawiera pojedynczą
argument wiersza poleceń (odpowiednik jednego z argv). Jedyne opcje, których nie może być
używane są same nazwy plików źródłowych oraz opcja `-delete'. Puste linie są
ignorowane, a linie zaczynające się od znaku „#” są komentarzami.

Program Dokumenty Komentarze
Dokumentacja programu jest tworzona z komentarzy w kodzie, które są
odpowiednio sformatowane. Odsyłacze pochodzą z samego kodu i nie wymagają
dodatkowa praca.

Specjalne komentarze to `/**** ****/' (dla pliku) i `/*++++ ++++*/' (dla danych
obiekt) wewnątrz standardowego komentarza `/*' i `*/' można użyć dowolnej liczby `*' lub `+'
ograniczników w komentarzach, są one ignorowane.

Jeśli linia komentarza zaczyna się od spacji i następuje po niej `+html+', to reszta
wiersz jest zawarty tylko w danych wyjściowych HTML i nie jest przetwarzany, więc może zawierać HTML
znaczników, `-html-' oznacza, że ​​reszta linii jest zawarta we wszystkich oprócz HTML
wyjście. To samo dotyczy innych formatów wyjściowych, `+none+' może być użyte dla linii
nie pojawiać się w żadnym wyjściu. Wyjątkiem jest to, że surowe wyjście nie robi żadnego
sprawdzanie i wyświetli wszystkie linie.

W każdej sytuacji, w której komentarz następuje po `,', `;' lub `)' oddzielone tylko spacjami i
tabulatorach, komentarz jest umieszczany przed znakiem interpunkcyjnym, aby zastosować go do znajdującego się tam obiektu.

Program jest realizowany przy użyciu pełnego parsera gramatyki ANSI C z niektórymi rozszerzeniami GCC,
oznacza to, że styl kodu jest nieistotny, tylko treść i komentarze.

Krzyż Odniesienia
Odsyłacze są przeprowadzane dla następujących pozycji

Akta
Pliki, w których znajduje się bieżący plik
(nawet jeśli są zawarte w innych plikach).

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

Zmienne
Lokalizacja definicji zmiennych zewnętrznych.
Pliki, które mają widoczność zmiennych globalnych.
Pliki/funkcje korzystające ze zmiennej.

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

Każdy z tych elementów jest odsyłaczami w danych wyjściowych.

Odsyłacze używają plików `cxref.variable', `cxref.function', `cxref.include' i
`cxref.typedef' w katalogu wyjściowym. Oto pełna lista funkcji i
użycie zmiennej 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
zbudować pliki odsyłaczy, a drugi je wykorzystać.

(Nazwy plików są inne, jeśli używana jest opcja `-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 tylko pliku makefile
zaktualizować zmienione pliki (chociaż odniesienia mogą wymagać, aby wszystkie pliki były
ponownie sprawdzone). Po napisaniu pliku cxref.tex użytkownik może go modyfikować,
wszelkie nowe pliki, które są dodawane, są dodawane na końcu sekcji kodu źródłowego, reszta
plik pozostaje niezmieniony.

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

Wypisano również trzy pliki stylów LaTeX-a `page.sty', `fonts.sty' i `cxref.sty'.
Konfigurują one stronę tak, aby używała mniejszego marginesu i mniejszych czcionek, aby umożliwić wyświetlanie większej liczby
stronę, a także zdefiniuj 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ślnym wyjściem HTML jest 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 tylko pliku makefile
zaktualizować zmienione pliki (chociaż odniesienia mogą wymagać, aby wszystkie pliki były
ponownie sprawdzone). Po napisaniu pliku cxref.html użytkownik może go modyfikować,
wszelkie nowe pliki, które są dodawane, są dodawane na końcu przed spisem treści, reszta
pliku bez zmian.

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

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

Dane wyjściowe HTML używają standardu HTML 4.01 i wszystkie strony są poprawnie sprawdzane.

RTF Wydajność
Format tekstu sformatowanego to dość niski format opisu strony opracowany przez firmę Microsoft. To
nie jest dobrze zdefiniowanym i łatwym do zrozumienia standardem, jak inne formaty, ale jest
popularny do wymiany dokumentów.

Istnieje jeden plik wyjściowy dla każdego z plików źródłowych i pliku indeksu.

SGML Wydajność
Ponieważ SGML jest metajęzykiem, konieczne jest również zdefiniowanie elementów layoutu
podać informacje. Dane wyjściowe cxref używają formatu dokumentu LinuxDoc i is
przeznaczony do użytku z programami SGMLtools (http://www.sgmltools.org/).

Istnieje jeden plik wyjściowy dla każdego z plików źródłowych i pliku indeksu.

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