6.1 Вывод в HTML

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

Вывод в HTML включает в себя следующие файлы (на модуль):

1.Общее описание модуля, с содержимым тэга descr для него. Здесь также описано предложение uses. Перечисляются все модули в предложении uses, в таблице вместе с их short (короткими) описаниями.

2.Список всех констант в модуле.

3.Список всех типов в модуле (кроме классов).

4.Список всех переменных в модуле.

5.Список всех функций/процедур в модуле.

6.Список всех классов в модуле.

7.Индексная страница модуля в пакете. Это индексная страница, в которой перечислены все идентификаторы верхнего уровня в текущем модуле или во всех модулях пакета.

Все эти обзоры, это гиперссылки на страницы, содержащие документацию по каждому идентификатору. Каждая страница начинается с имени идентификатора, плюс краткий обзор (сделанный из содержимого тега short). После этого следует объявление и описание. Описание заполняется узлом descr тега element идентификатора.

Если присутствует тег errors, за описанием следует раздел описания 'Ошибок'. Аналогично, если есть тег seealso, то создаётся раздел 'См. также' с перекрестными ссылками.

Для классов объявление содержит гиперссылки для отдельных страниц, которые документируют все члены класса. Каждому члену объявления соответствует short тег элемента элемента , если он существует.

Кроме того, предоставляется иерархия классов, а также ссылки на всплывающие страницы (если доступен JavaScript, в противном случае это обычные ссылки), которые содержат алфавитные или иерархические списки методов, полей или свойств этого класса.

Для функций и процедур объявление будет набираться таким образом, чтобы все аргументы функции (если они присутствуют) были в табличном формате, а затем краткое описание аргумента. Если это касается функции и существует элемент результата, описание результата будет представлено в отдельном разделе перед фактическим описанием.

Объявление перечисляемого типа будет выложено в таблице, с указанием значения перечисления слева и узлом короткого описания элемента значения.