четверг, января 24, 2008

Параметры командной строки ASDoc

-doc-classes path-element [...] - cписок документируемых классов. Эти классы должны располагаться в директории с исходным кодом. Этот параметр используется по умолчанию.

-doc-namespaces uri manifest - список URI (пространства имен), классы которых должны быть документированы. Эти классы должны располагаться в директории с исходным кодом. Необходимо указать URI и место размещения файла, определяющего содержимое пространства имен.

-doc-sources path-element [...] - список документируемых файлов. Если в списке указана директория, происходит рекурсивная обработка ее файлов.

-exclude-classes string - список классов, которые не будут включены в документацию. Необходимо указывать имя каждого усключаемого класса. Аналогично работает тег @private, указанный при комментировании класса - класс не документируется.

-exclude-dependencies true/false - определяет, будут ли документироваться зависимости, найденные компилятором. Если указано true - зависимости вводимых классов не будут документироваться. По умолчанию false.

-footer string - текст в нижней части HTML-страницы.

-left-frameset-width int - целое число, устанавливающее ширину левого фрейма страницы документа. Можно менять это значение с тем, чтобы подстроить фрейм под ширину имен пакетов классов. По умолчанию 210 пикселей.

-main-title "string" - текст в верхней области HTML-страницы. По умолчанию "API Documentation".

-output string - директория, в которой будут размещаться файлы документации. По умолчанию "asdoc-output".

-package name "description" - текст, документирующий пакет классов. Этот параметр можно указывать повторно для описания множества пакетов классов. Например:

asdoc -doc-sources my_dir -output myDoc -package com.my.business "Contains business classes and interfaces" -package com.my.commands "Contains command base classes and interfaces"

-templates-path string - путь к директории с шаблонами ASDoc-документации. По умолчанию, используются шаблоны, размещенные в поддиректории "asdoc/templates" каталога, где установлен ASDoc. Директория содержит файлы HTML, CSS, XSL и файлы изображений, используемы для создания документации.

-window-title "string" - текст на верхней панели окна интернет-браузера. По умолчанию "API Documentation".

Типичная строка для генерирования ASDoc-документации:

asdoc -doc-sources "Путь к файлам исходного кода" -main-title "Название проекта" -output "Каталог с документацией"

* * *

Столкнулся с проблемой. Код [Event(name="buttonDown", <strong>type="mx.events.FlexEvent"</strong>)] вызывает ошибку компиляции ASDoc. После того, как убрал теги <strong> всё прокатило.

Комментариев нет: