cxref - Интернет в облаке

ПРОГРАММА:

ИМЯ

cxref - Инструмент C перекрестных ссылок и документирования.

СИНТАКСИС

cxref имя файла [ ... имя файла] [-Оимя_директории] [-Нбазовое имя] [-Рбазовое имя] [-все-комментарии]
[-без комментариев] [-дословно-комментарии] [-блок-комментарии]
[-xref [-all] [- файл] [- функция] [- var] [- тип]] [-warn [-all] [- комментарий] [- xref]]
[-index [-all] [- file] [- func] [- var] [- type]] [-сырой] [-латекс] [-html [-src]] [-rtf] [-sgml]
[-Яимя_директории] [-Допределять] [-Уопределять] [-КПП cpp_program] [- cpp_args ... cpp_args]

cxref имя файла [ ... имя файла] -удалять [-Оимя_директории] [-Нбазовое имя] [-Рбазовое имя]

ОПИСАНИЕ

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

Входными данными является любая программа на C с соответствующими комментариями, а на выходе - LaTeX, HTML, RTF или
Файлы SGML.

ДОПОЛНИТЕЛЬНЫЕ УСЛУГИ, НЕ ВКЛЮЧЕННЫЕ В ПАКЕТ

имя файла
Имя файла для документирования; одновременно может быть задокументировано любое количество файлов.

-удалять
Названные файлы должны быть удалены из выходного каталога, а их записи в
база данных перекрестных ссылок и основные выходные файлы должны быть удалены.

-Одирнаме
Имя каталога, используемого для выходных файлов latex, и расположение
создаваемые файлы перекрестных ссылок.

-Nбазовое имя
Имя для использования вместо первой части выходных файлов и файлов перекрестных ссылок.
cxref расширения файлов остаются прежними.

-Rdirname
Если исходные файлы находятся в более чем одном каталоге, установите dirname равным имени
корневой каталог исходного дерева (используйте относительный путь, если проще, например, `-R ../ ..«).
Затем это запустит cxref из этого корневого каталога, и `-Odirname 'должно быть
относительно этого каталога.

-все-комментарии
Если вы считаете, что существующие комментарии могут работать (см. Описание выше
специальных комментариев). [Опасность! Этот вариант может привести к странным результатам.]

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

-verbatim-комментарии
Когда комментарии, которые у вас есть в коде, отформатированы в заранее определенном стиле
которые вы хотите сохранить на выходе, эта опция заставит их не быть
переформатирован. [Обратите внимание, это только для комментариев к файлам и функциям.]

-блок-комментарии
Когда комментарии в программе отформатированы в стиле `блочный '(с ведущими
'*' в каждой строке), эта опция удалит этот символ из
выход. [Работает для одиночных `* ',` +', `| ' или `: 'в каждой строке.]

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

-предупреждать Создавать предупреждения, параметры должны быть объединены вместе:
-все предупреждения.
-комментарий Предупреждать об отсутствующих комментариях.
-xref Предупреждать об отсутствии перекрестных ссылок.

-индекс Создайте индекс перекрестных ссылок, параметры должны быть объединены вместе:
-все индексы.
-file Индекс файлов.
-func Указатель функций.
-var Индекс переменных.
-type Указатель типов.

-сырой Создавать необработанную форму вывода, бесполезную, за исключением -warn.

-латекс Создайте файл LaTeX для документирования каждого из исходных файлов, а также дополнительный файл
который включает каждый из этих файлов.

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

-html-источник
Создайте HTML-вывод и HTML-версию исходного файла со ссылками на него.

-rtf Создайте файл в формате RTF, чтобы задокументировать исходный файл.

-sgml Создайте файл SGML для документирования исходного файла. (Используя LinuxDoc DTD).

-Идирнаме
Параметр GCC, чтобы указать путь для включаемых файлов.

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

-Удефине
Параметр GCC для отмены определения символа препроцессора.

-CPP программа
Имя программы, которая будет использоваться вместо времени компиляции по умолчанию. Программа
должен иметь возможность выполнять все действия, которые для работы выполняет `gcc -E -C -dD '. Если
программа принимает аргументы, тогда все это нужно заключить в кавычки, чтобы
интерпретируется как единственный аргумент для cxref.

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

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

Использование: cxref-cc [обычные параметры cc]

Имя исходного файла извлекается из списка опций, а также из `-D * ',
Флаги `-I * ',` -U *' и при успешном завершении работы компилятора C будет вызываться cxref. В
имя используемого компилятора C контролируется переменной среды CXREFCC, или если
это не установлено тогда переменная среды CC, или в противном случае это просто gcc.

Использование этого сценария требует использования файла конфигурации `.cxref ', чтобы содержать параметры
поскольку в командной строке компилятора C некуда помещать параметры.

Это будет только перекрестная ссылка и документирование исходных файлов C, поскольку они являются единственными
те, которые скомпилированы, но убедитесь, что на них есть перекрестные ссылки с
правильные варианты и т. д.

Cxref Конфигурация Файл
Эти аргументы командной строки также можно поместить в файл с именем `.cxref 'вместо
командная строка. При запуске cxref аргументы программы интерпретируются в
в следующем порядке.

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

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

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

FitPartner™ Документация Комментарии
Документация к программе составлена ​​из комментариев в коде, которые
правильно отформатирован. Перекрестная ссылка исходит из самого кода и не требует
Дополнительная работа.

Специальными комментариями являются `/ **** **** / '(для файла) и` / * ++++ ++++ * /' (для данных
объект) любое количество `* 'или` +' может использоваться внутри стандартного комментария `/ * 'и` * /'
разделители в комментариях, они игнорируются.

Если строка комментария начинается с пробела и сопровождается `+ html + ', то оставшаяся часть
строка включается только в вывод HTML и не обрабатывается, поэтому может включать HTML
разметка, `-html- 'означает, что остальная часть строки включена во все, кроме HTML
выход. То же самое относится и к другим форматам вывода, для строк можно использовать `+ none + '
не появляться ни в каком выводе. Исключением является то, что необработанный вывод не выполняет никаких действий.
проверка и выведет все строки.

В любой ситуации, когда комментарий следует за `, ',`;' или `) ', разделенные только пробелами и
вкладки, комментарий помещается перед пунктуацией, чтобы применить к объекту там.

Программа реализована с использованием полного анализатора грамматики ANSI C с некоторыми расширениями GCC,
это означает, что стиль кода не важен, только содержание и комментарии.

Пересекать привязка
Перекрестная ссылка выполняется для следующих элементов

Файлы
Файлы, в которые включен текущий файл
(даже при включении через другие файлы).

#включает в себя
Файлы, включенные в текущий файл.
Файлы, включенные в эти файлы и т. Д.

Переменные
Расположение определения внешних переменных.
Файлы с видимостью глобальных переменных.
Файлы / функции, использующие переменную.

функции
Файл, в котором прототип функции.
Функции, которые вызывает функция.
Функции, вызывающие функцию.
Файлы и функции, которые ссылаются на функцию.
Переменные, которые используются в функции.

Каждый из этих элементов имеет перекрестные ссылки в выходных данных.

Для перекрестных ссылок используются файлы cxref.variable, cxref.function, cxref.include и
cxref.typedef в выходном каталоге. Это полный список функций и
использование переменных в программе и может использоваться для создания иерархии вызовов функций или
диаграмма использования переменных например. Для каждого файла требуется два прохода cxref, первый для
создать файлы перекрестных ссылок, а второй использовать их.

(Имена файлов будут другими, если используется опция -N.)

Латекс Результат
Выходные данные 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