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

ПРОГРАММА:

ИМЯ

fpdoc - Генератор документации модуля FPC Pascal.

СИНТАКСИС

fpdoc --input = inputcommand [--output = output] [--format = fmt] [--descr = descriptionfile]
[--package = packagename] [параметры]

Описание

fpdoc сканирует исходный файл модуля Free Pascal и создает для него документацию. В
документация может быть в различных форматах (в настоящее время HTML и LaTeX). Она может читать различные
файлы описания, которые содержат описание различных символов, найденных в устройстве
.

Применение

Вы можете вызвать fpdoc с единственным обязательным аргументом "ввод" и "пакет"
аргументы. Он должен, по крайней мере, содержать имя файла модуля, для которого документация
должно быть сгенерировано и имя пакета, которому принадлежит модуль.

Возможности

fpdoc имеет несколько опций, большинство из которых являются необязательными, в большинстве случаев будут использоваться значения по умолчанию.

--содержание
Эта опция сообщает fpdoc для создания файла содержимого. Файл содержимого содержит список
всех возможных якорей (меток) в сгенерированном файле документации и может
использоваться для создания перекрестных ссылок в документации для различных устройств, используя
--Импортировать опцию.

--cputarget = значение
Эта опция сообщает fpdoc для какого процессора создавать документацию. Это просто
определяет соответствующие макросы ЦП.

--descr = descfile
Эта опция указывает имя файла описания. файл описания который содержит
актуальная документация на агрегат. Этот вариант можно давать несколько раз, для
несколько файлов описания.

--descr-dir = dir
Этот параметр указывает имя каталога с файлами описания XML с именем директория
Эта опция может быть указана несколько раз для нескольких каталогов описания. Этот
опция эквивалентна указанию всех файлов в каталоге с помощью --descr
опцию.

--не обрезать
Этот параметр указывает fpdoc не обрезать пробелы в файлах XML. По умолчанию,
пробелы удаляются из ввода, что может иметь нежелательные побочные эффекты в
например, теги PRE.

--прогон, репетиция
Эта опция сообщает fpdoc не генерировать какой-либо вывод, а просто анализировать весь ввод. Этот
можно использовать с опцией подробного вывода, чтобы проверить, какие ошибки остаются в
документация или то, что еще отсутствует.

--format = fmt
Определяет формат FMT в котором будет создаваться документация. В настоящее время
известны следующие форматы:

CHM CHM с соответствующими именами файлов 8.3, в основном для Windows.

dxml Вывод XML, совместимый с Delphi.

HTM HTML с соответствующими именами файлов 8.3.

HTML HTML с длинными именами файлов.

IPF Вывод IPF (формат OS / 2, можно использовать с docview из fpGUI).

xhtml XHTML с длинными именами файлов.

латекс LaTex, в котором используется стиль fpc.sty, используемый в документации Free Pascal.

человек вывод страницы руководства (страницы руководства unix, по одной странице на идентификатор).

RTF RTF-вывод.

текст Обычный текстовый вывод.

xml-структура
Структурированный XML.

--Помогите Показать сводку параметров командной строки.

- с защитой от шкуры
По умолчанию документация будет включать описания и списки защищенных
поля и методы в классах или объектах. Эта опция меняет это поведение; если оно
указано, для этих методов документация создаваться не будет. Обратите внимание, что
общедоступные методы или свойства, которые относятся к этому защищенному методу, будут иметь
висящая (т.е. недоступная) ссылка.

--html-search = ссылка
Добавляет запись для страницы поиска HTML в местоположении ссылке. в заголовках
сгенерированные HTML-страницы. Страница поиска отсутствует, это необходимо сделать и
предоставляется пользователем.

--import = impfile
импортирует файл содержимого протыкать из другого набора документации. Это можно использовать для
разрешить ссылки на элементы в этом другом файле документации;

--input = cmd
Эта опция сообщает fpdoc какой входной файл следует использовать. Аргумент CMD может быть
просто имя файла, но также может быть полной командной строкой компилятора с параметрами, которые
касается сканирования источника паскаль: определяет, включает файлы, параметры синтаксиса,
поскольку они будут указаны компилятору Free Pascal при компиляции файла. Если
используется полная команда, тогда она должна быть заключена в одинарные или двойные кавычки,
так скорлупа не разобьет их по частям. Можно указать несколько
команды ввода; они будут рассматриваться один за другим, а документация будет
генерируется для каждого из них.

--input-dir = dir
Эта опция сообщает fpdoc чтобы добавить все файлы .pas и .pp в каталог с именем CMD as
входные файлы в документатор. Это эквивалентно указанию всех файлов в
каталог с --Вход команда.

--lang = язык
Устанавливает язык для выходного файла. Это в основном установит строки, используемые для
заголовки в различных частях файлов документации (по умолчанию они находятся в
английский). В настоящее время допустимые варианты:

de Немецкий.

fr Французский.

nl Голландский.

--latex-extension = ext
Устанавливает расширение, используемое для файла LaTeX, на Ext по умолчанию .tex (с участием .
(точка) в комплекте).

--латекс-подсветка
Включает внутреннюю подсветку синтаксиса латекса. Это еще не реализовано. К
по умолчанию подсветка синтаксиса обеспечивается пакетом синтаксиса, поставляемым с fpc.

--mo-dir = dir
Эта опция сообщает fpdoc где искать файлы перевода, которые можно использовать для
интернационализировать вывод fpdoc.

--ostarget = значение
Эта опция сообщает fpdoc для какой операционной системы создавать документацию. Этот
просто определяет соответствующие макросы операционной системы.

--output = имя
Эта опция сообщает fpdoc где должен быть сгенерирован выходной файл. Как этот вариант
интерпретируется в зависимости от используемого формата. Для латекса, имя интерпретируется
как имя файла tex. Для всех остальных форматов имя интерпретируется как
каталог, в который будут записаны все файлы документации. Каталог будет
создается, если он еще не существует. Стандартно соответствует имени пакета.

--package = имя пакета
Задает имя пакета. Все объекты будут задокументированы как часть имя пакета ,
который также является именем выходного файла или каталогом по умолчанию. Только узлы документации
внутри узла пакета с таким именем будет учитываться при документировании.

--parse-импл
(Экспериментально) попробуйте также разобрать реализацию модуля, это можно использовать для
проверка синтаксиса.

--project = файл
Эта опция сообщает fpdoc чтобы прочитать все параметры из файла проекта. Это XML
файл, пожалуйста, обратитесь к документации для получения дополнительной информации о формате для этого
.

--show-private
По умолчанию для частных методов или полей документация не создается. Этот
Вариант причины fpdoc также для создания документации по этим методам.

--подробный
По умолчанию fpdoc скудно с выходом. Это говорит fpdoc создать еще
информация о том, что он делает.

--предупреждать-нет-узла
Если указана эта опция, fpdoc выдаст предупреждение, если не найдет
узел описания для идентификатора, который он документирует.

--write-project = файл
Если указана эта опция, fpdoc запишет файл проекта fpdoc (в
указанное имя файла), который соответствует указанным параметрам командной строки.

Используйте fpdoc-3.0.0 онлайн с помощью сервисов onworks.net