FPDoc

Документатор кода Free Pascal:

Справочное руководство


Справочное руководство для FPDoc

Версия документа 3.0.4

28 сентября 2017 г.

Michaël Van Canneyt


© GNU

Глава 1 Введение

1.1 Об этом документе

1.2 О FPDoc

1.3 Получение дополнительной информации.

Глава 2 Компиляция и установка FPDoc

2.1 Компиляция

2.2 Установка

Глава 3 Использование FPDoc

3.1 fpdoc

3.2 Справочник по параметрам командно строки FPDoc

3.2.1 auto-index

3.2.2 auto-toc

3.2.3 charset

3.2.4 chm-title

3.2.5 content

3.2.6 css-file

3.2.7 default-page

3.2.8 descr

3.2.9 emit-notes

3.2.10 footer

3.2.11 footer-date

3.2.12 format

3.2.13 help

3.2.14 hide-protected

3.2.15 html-search

3.2.16 image-dir

3.2.17 image-url

3.2.18 import

3.2.19 index-colcount

3.2.20 index-file

3.2.21 input

3.2.22 lang

3.2.23 latex-highlight

3.2.24 make-searchable

3.2.25 other-files

3.2.26 output

3.2.27 package

3.2.28 project

3.2.29 show-private

3.2.30 toc-file

3.2.31 warn-no-node

3.2.32 write-protect

3.3  makeskel

3.3.1 Введение

3.4 Справочник по опциям makeskel

3.4.1 descr

3.4.2 dasable-arguments

3.4.3 dasable-errors

3.4.4 dasable-function-results

3.4.5 dasable-override

3.4.6 dasable-private

3.4.7 dasable-protected

3.4.8 dasable-seealso

3.4.9 emitclassseparator

3.4.10 help

3.4.11 input

3.4.12 lang

3.4.13 output

3.4.14 package

3.4.15 update

Глава 4 Файл проекта

4.1 Введение

4.2 Структура файла проекта

4.2.1 Узел опций (options)

4.2.2 Узел опции (option)

4.2.3 Узел пакетов (packages)

4.2.4 Узел пакета (package)

4.2.5 Узел модулей (units)

4.2.6 Узел модуля (unit)

4.2.7 Узел описаний (descriptions)

4.2.8 Узел описания (description)

Глава 5 Описание файла

5.1 Введение

5.2 Название элемента и ссылки

5.2.1 Соглашения об именах элементов

5.2.2 Перекрестная ссылка: тег link

5.3 Справочник по Тегам

5.3.1 Обзор

Тэги документации

5.3.12 fpdoc-description: Глобальный тэг

5.3.22 pakage: Описание пакета

5.3.17 module: Описание модуля

5.3.9 element: Идентификатор документации

5.3.31 topic: Раздел - тема

5.3.27 short: Короткое описание

5.3.5 descr: Описание

5.3.10 errors: Ошибки раздела

5.3.11 example: Включить исходный код из файла

5.3.26 seealso: Раздел "смотри так-же"

5.3.18 notes: Заметки (анотации)

Тэги форматирования

5.3.2 b: Форматирование жирным

5.3.13 i: Форматирование наклонным

5.3.33 u: Форматирование подчёркиванием

5.3.36 var: Переменная (идентификатор)

file: Альтернативное форматирование

5.3.21 p: Абзац (параграф)

5.3.23 pre: Вставить текст как-есть

5.3.25 remark: Реплика

5.3.24 printshort: Короткое описание (в тексте)

5.3.4 code: Формат кода на Pascal

5.3.14 img: Включить изображение

5.3.37 version: Инфовмация по версии

5.3.19 note: Примечание/Анотация

Таблица

5.3.28 table: Табтица

5.3.3 caption: Заголовок таблицы

5.3.30 th: Заголовок таблицы

5.3.32 tr: Строка в таблице

5.3.29 td: Ячейка таблицы

Определение

5.3.7 dl: Определение списка

5.3.8 dt: Определение термина

5.3.6 dd: Определение данных

Списки

5.3.20 ol: Нумерованный список

5.3.34 ul: Маркированный список

5.3.15 li: Элемент списка

Ссылки

5.3.16 link: Перекрёстная ссылка

5.3.35 url: Гиперссылка

Глава 6 Сгенерированные выходные файлы

6.1 Вывод в HTML

6.2 Вывод в Latex

6.3 Вывод в CHM

6.4 Вывод в TXT

6.5 Вывод в RTF

6.6 Вывод в Man