Структура документации

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

Для файла ресурса генерируется заглавная страница. Она содержит информацию по ресурсному файлу, в том числе:

• список компонент со ссылками на их описание;

• список базовых сущностей : типы данных, объектные интерфейсы, объекты (vip-интерфейсы), меню, статус-строки, кнопки главного меню (деск), точки расширения и т.д. с кратким описанием и со ссылками на их развернутое описание;

• ссылку на алфавитный указатель;

• ссылку на страницу описания web-сервисов;

• ссылку на страницу описания статических функций.

Далее для каждой документируемой сущности генерируется аналогичная страница, содержащая ее развернутое описание и список вложенных сущностей (если такие есть).

Например, для объектного интерфейса описание содержит:

• имя интерфейса и его развернутое описание;

• список свойств;

• список методов;

• список объектных индексов;

• список потоков данных.

А для переменной описание состоит из имени, типа и содержимого директивы #doc.