3.2.26 output

На верх  Назад  Вперёд

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

Имя файла или имя каталога интерпретируется как относительно текущего каталога.

Пример:

--format=html --output=docs/classes

будет генерировать HTML-документацию в каталоге docs/classes.

--format=latex --output=docs/classes.tex

будет генерировать латексную документацию в файлах docs/classes.

--format=chm --output=docs.chm

будет генерировать chm-документацию в файле docs.chm.