3.2.8 descr

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

Этот параметр указывает имя файла описания, содержащего фактическую документацию для устройства. Эта опция может быть предоставлена ​​несколько раз, для нескольких файлов описания. Файл будет искать по отношению к текущему каталогу. В файл не добавляется расширение, оно должно быть полным именем файла.

Если имя файла начинается с знака «at» @, то оно интерпретируется как текстовый файл, который содержит список имен файлов, по одному на строку. Каждый из этих файлов будет добавлен в список файлов описания.

Узлы в файлах описания будут объединены в одно большое дерево. Это означает, что документацию можно разделить на несколько файлов. При объединении файлов описания узлы, которые встречаются дважды, заканчиваются только один раз в дереве больших узлов: последний узел всегда будет узлом, который попадает в дерево разбора. Это означает, что порядок различных входных команд или порядок файлов в списке файлов важен.

Примеры:

--descr = crt.xml

сообщит FPDoc для чтения документации из crt.xml , в то время как

--descr=@fcl.lst

скажет FPDoc, чтобы читать имена файлов из fcl.lst ; каждый из найденных в нем имен файлов будет добавлен в список файлов, подлежащих проверке для описания.