cxref - Інтернет у хмарі

ПРОГРАМА:

ІМ'Я

cxref — інструмент перехресних посилань і документування C.

СИНТАКСИС

cxref ім'я файлу [ ... ім'я файлу] [-Опрізвище] [-Нбазове ім'я] [-Рбазове ім'я] [-всі-коментарі]
[-без коментарів] [-verbatim-comments] [-block-comments]
[-xref[-all][-file][-func][-var][-type]] [-warn[-all][-comment][-xref]]
[-index[-all][-file][-func][-var][-type]] [-raw] [-латекс] [-html[-src]] [-rtf] [-sgml]
[-Іпрізвище] [-Dвизначати] [-Увизначати] [-CPP cpp_program] [-- cpp_args ... cpp_args]

cxref ім'я файлу [ ... ім'я файлу] -видалити [-Опрізвище] [-Нбазове ім'я] [-Рбазове ім'я]

ОПИС

Програма, яка може автоматично створювати документацію та перехресні посилання для C
програми.

Вхідними даними є будь-яка програма на C з відповідними коментарями, а вихідними – LaTeX, HTML, RTF або
файли SGML.

ВАРІАНТИ

ім'я файлу
Ім’я файлу для документування, будь-яка кількість файлів може бути задокументована одночасно.

-видалити
Названі файли мають бути видалені з вихідного каталогу та їхні записи
базу даних перехресних посилань і основні вихідні файли потрібно видалити.

-Одірім'я
Ім'я каталогу, який буде використовуватися для вихідних латексних файлів, і розташування
файли перехресних посилань, які створюються.

-Nbasename
Ім’я для першої частини вихідних даних і файлів перехресних посилань
cxref, розширення файлів залишаються незмінними.

-Rdirname
Якщо вихідні файли знаходяться в кількох каталогах, встановіть для dirname назву
кореневий каталог вихідного дерева (використовуйте відносний шлях, якщо простіше, наприклад `-R../ ..').
Потім буде запущено cxref із цього кореневого каталогу, і має бути `-Odirname'
відносно цього каталогу.

-всі коментарі
Якщо ви вважаєте, що наявні коментарі можуть спрацювати (опис див. вище
спеціальних коментарів). [Небезпека! Цей варіант може призвести до дивних результатів.]

-без коментарів
Ігнорує всі коментарі, корисно, якщо вам потрібні лише перехресні посилання, а не
документація.

-дослівні коментарі
Коли коментарі, які ви маєте в коді, відформатовано в попередньо визначеному стилі
які ви хочете зберегти на виході, ця опція змусить їх не бути
переформатований. [Зверніть увагу, це лише коментарі до файлів і функцій.]

-блок-коментарі
Коли коментарі в програмі відформатовані в стилі «блок» (з ініціалом
символ «*» у кожному рядку), ця опція видалить цей символ із
вихід. [Працює для одного `*', `+', `|' або `:' у кожному рядку.]

-xref Надайте інформацію про перехресні посилання (див. нижче).
-all Усі перехресні посилання.
-file Перехресні посилання на файли.
-func Перехресні посилання для функцій.
-var Перехресні посилання для змінних.
-type Перехресні посилання для типів.

- попередити Створення попереджень, параметри мають бути об’єднані разом:
-все Усі попередження.
-comment Попередити про відсутні коментарі.
-xref Попередити про відсутність перехресних посилань.

-індекс Створіть індекс перехресних посилань, параметри мають бути об’єднані разом:
-все Всі індекси.
-file Індекс файлів.
-func Покажчик функцій.
-var Індекс змінних.
-тип Покажчик типів.

-сирий Створення необробленої форми виведення, яка насправді не дуже корисна, за винятком -warn.

-латекс Створіть файл LaTeX, щоб задокументувати кожен із вихідних файлів, а також додатковий файл
який включає кожен із цих файлів.

-html Створіть файл HTML 4.01 для документування кожного з вихідних файлів і основного файлу
посилання на кожен із цих файлів.

-html-src
Створення HTML-версії вихідного файлу з посиланнями на нього.

-rtf Створіть файл RTF (Rich Text Format), щоб задокументувати вихідний файл.

-sgml Створіть файл SGML, щоб задокументувати вихідний файл. (Використовуючи LinuxDoc DTD).

- Ім'я імені
Параметр GCC для вказівки шляху для файлів підключення.

-D визначте
Опція GCC для визначення символу препроцесора.

-Udefine
Опція GCC для скасування визначення символу препроцесора.

-CPP програма
Назва програми, яка буде використовуватися замість стандартного часу компіляції. Програма
має бути в змозі виконувати всі дії, які робить `gcc -E -C -dD' для роботи. Якщо
програма приймає аргументи, тоді все має бути в лапках, щоб воно
інтерпретується як єдиний аргумент для cxref.

--аргумент ... аргумент
Додаткові аргументи, які будуть передані препроцесору, можна розмістити після `--'
сепаратор.

C компілятор Заміна cxref-cc
Щоб спростити використання cxref у існуючому вихідному коді, тепер існує сценарій оболонки, який буде
викликати компілятор C, а потім викликати cxref для обробки вихідного файлу. Це означає, що це
можна використовувати як заміну CC у Makefiles тощо.

Використання: cxref-cc [звичайні параметри cc]

Ім'я вихідного файлу витягується зі списку параметрів, а також `-D*',
Прапори `-I*', `-U*' і коли компілятор C завершиться успішно, буде викликано cxref. The
Ім'я використовуваного компілятора C контролюється змінною середовища CXREFCC або if
це не встановлено, тоді змінна середовища CC, або, якщо це не вдається, просто gcc.

Використання цього сценарію вимагає використання файлу конфігурації `.cxref', який містить параметри
оскільки немає куди розмістити параметри в командному рядку для компілятора C.

Це лише перехресні посилання та документування вихідних файлів C, оскільки вони є єдиними
ті, які скомпільовані, але він переконається, що вони перехресні посилання з
правильні варіанти тощо.

Cxref конфігурація філе
Ці аргументи командного рядка також можна помістити у файл із назвою `.cxref' замість файлу
командний рядок. Під час запуску cxref аргументи програми інтерпретуються в
наступний порядок.

(1) Ті, що знаходяться в командному рядку. (2) Ті, що знаходяться у файлі `.cxref' у поточному каталозі.
(3) Ті, що містяться у файлі `.cxref' у корені вихідного дерева, визначеному `-R'.

Це означає, що у вихідному дереві з кількома каталогами кожен підкаталог може мати `.cxref'
файл, що містить лише рядок `-R..' або відповідний. Головний каталог може мати a
Файл `.cxref', що містить решту параметрів. Це повністю знімає потребу
мати будь-які параметри в командному рядку, окрім імен вихідних файлів.

Формат файлу `.cxref' — будь-яка кількість рядків, кожен з яких містить один
аргумент командного рядка (еквівалентний одному з argv). Єдиних варіантів, яких бути не може
використовуються назви самих вихідних файлів і параметр `-delete'. Порожні рядки є
ігнорується, а рядки, що починаються з '#', є коментарями.

програма документація Коментарі
Документація до програми складається з коментарів у коді, які є
відповідним чином відформатований. Перехресні посилання походять із самого коду й не потребують
додаткова робота.

Спеціальними коментарями є «/**** ****/» (для файлу) та «/*++++ +++++/» (для даних
об’єкт) будь-яку кількість «*» або «+» можна використовувати всередині стандартних коментарів «/*» та «*/»
роздільники в коментарях, вони ігноруються.

Якщо рядок коментаря починається з пробілу та супроводжується `+html+', то решта
рядок включається лише у вивід HTML і не обробляється, тому може містити HTML
розмітки, `-html-' означає, що решта рядка включено в усі, крім HTML
вихід. Те саме стосується й інших форматів виводу, `+none+' можна використовувати для рядків
не відображатися в жодному виведенні. Винятком є ​​те, що необроблений вихід нічого не робить
перевіряє та виводить усі рядки.

У будь-якій ситуації, коли коментар слідує за `,', `;' або `)', розділені лише пробілами та
вкладки, коментар розміщується перед розділовим знаком, щоб застосувати до об’єкта там.

Програма реалізована за допомогою повного аналізатора граматики ANSI C з деякими розширеннями GCC,
це означає, що стиль коду неважливий, лише зміст і коментарі.

Перетинати Довідкова інформація
Перехресне посилання виконується для наступних елементів

Файли
Файли, до яких включено поточний файл
(навіть якщо включено через інші файли).

#включає
Файли, включені в поточний файл.
Файли, включені до цих файлів тощо.

Змінні
Розташування визначення зовнішніх змінних.
Файли, які мають видимість глобальних змінних.
Файли/функції, які використовують змінну.

Функції
Файл, у якому створено прототип функції.
Функції, які функція викликає.
Функції, які викликають функцію.
Файли та функції, які посилаються на функцію.
Змінні, які використовуються у функції.

Кожен із цих елементів містить перехресні посилання у вихідних даних.

Перехресне посилання використовує файли `cxref.variable', `cxref.function', `cxref.include' та
`cxref.typedef' у вихідному каталозі. Це повний список функцій і
використання змінних у програмі та може використовуватися для створення ієрархії викликів функцій або
наприклад, діаграма використання змінної. Необхідно два проходи cxref для кожного файлу, перший до
створити файли перехресних посилань, а потім використовувати їх.

(Імена файлів відрізняються, якщо використовується параметр `-N'.)

LaTeX Вихід
Типовим виходом LaTeX є файл для кожного вихідного файлу з одним додатковим файлом
`cxref.tex', який містить усі інші файли. Це дозволяє тільки make-файлу
оновити змінені файли (хоча посилання можуть вимагати, щоб усі файли були
перевірено ще раз). Після написання файлу cxref.tex він може бути змінений користувачем,
будь-які нові файли, які додаються, додаються в кінці розділу вихідного коду, решта
файл залишається без змін.

Індекс записується у файл під назвою `cxref.apdx.tex', а cxref.tex оновлюється для посилання
до цього

Також виписано три файли стилів LaTeX `page.sty', `fonts.sty' і `cxref.sty'.
Вони налаштовують сторінку на використання менших полів і дрібніших шрифтів, щоб дозволити відображати більше
сторінку, а також визначте нові команди для набору виводу cxref.

(Назви файлів `cxref.tex' і `cxref.apdx.tex' відрізняються, якщо встановлено параметр `-N'
використовується.)

HTML Вихід
Вихід HTML за умовчанням є файлом для кожного з вихідних файлів з одним додатковим файлом
`cxref.html', який містить усі інші файли. Це дозволяє тільки make-файлу
оновити змінені файли (хоча посилання можуть вимагати, щоб усі файли були
перевірено ще раз). Після написання файлу cxref.html користувач може змінити його,
будь-які нові файли, які додаються, додаються в кінці перед змістом, решта
файлу без змін.

Індекс записується у файл під назвою `cxref.apdx.html', а cxref.html оновлюється для посилання
до цього

(Імена файлів `cxref.html' і `cxref.apdx.html' відрізняються, якщо встановлено параметр `-N'
використовується.)

Вихід HTML використовує стандарт HTML 4.01, і всі сторінки перевіряються правильно.

RTF Вихід
Формат Rich Text Format — це формат опису сторінки досить низького рівня, розроблений Microsoft. Це
не є чітко визначеним і простим для розуміння стандартом, як інші формати, але це так
популярний для обміну документами.

Існує окремий вихідний файл для кожного з вихідних файлів та файл індексу.

SGML Вихід
Оскільки SGML є мета-мовою, необхідно також визначити елементи макета
надати інформацію. Вихід cxref використовує формат документа LinuxDoc і є
призначений для використання з програмами SGMLtools (http://www.sgmltools.org/).

Існує окремий вихідний файл для кожного з вихідних файлів та файл індексу.

Використовуйте cxref онлайн за допомогою сервісів onworks.net