4.1 Введение

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

Когда имеется много модулей для документирования, командная строка может быть довольно длинной. В некоторых операционных системах это проблема, так как длина командной строки легко превышает максимальную длину параметров командной строки, поддерживаемых ОС. Кроме того, командные строки трудно читать и/или анализировать. fpdoc всегда поддерживал параметры чтения из файла, но это не очень структурировано и сложно обрабатывать, например, в среде IDE.

Поэтому можно написать файл проекта. Файл проекта представляет собой файл XML, описывающий проект fpdoc. XML-файл содержит только несколько имен тегов.

В общем, это выглядит следующим образом:

<?xml version="1.0" encoding="utf-8"?>
<docproject>
<options>
  <option name="ostarget" value="Linux"/>
  <option name="cputarget" value="x86_64"/>
  <option name="show-private" value="false"/>
  <option name="stop-on-parser-error" value="false"/>
</options>
<packages>
  <package name="rtl" output="rtl" content="rtl.xct">
    <units>
      <unit file="../rtl/objpas/objpas.pp"
            options="-dHASINTF"/>
      <unit file="../rtl/objpas/types.pp"
            options=""/>
    </units>
    <descriptions>
      <description file="rtl.xml"/>
      <description file="system.xml"/>
    </descriptions>
  </package>
</packages>
</docproject>