Объединение phpdoc с существующим docbook - PullRequest
Новая
       13

Объединение phpdoc с существующим docbook

0 голосов
/ 10 июня 2010

Я бы хотел включить сгенерированную phpdoc документацию в мою уже существующую документацию docbook.

Моя идея состояла в том, чтобы phpdoc сгенерировал документацию в формате docbook и затем импортировал части (на основе пакетов иподпакеты) из этого с использованием XInclude.Я использую Docbook 5 для моей документации.Есть ли способ достичь этого?

То, что я пробовал до сих пор, это создание docbook с использованием XML:DocBook/peardoc2:default в качестве параметра phpdoc.

Докбук PHPDocumentor разделен на несколько файлов - это здорово, но файлы выглядят примерно так 

<chapter id="package.default">
<title>default</title>
&package.default.default;
&package.default.foobar;
</chapter>

Насколько я понимаю, это внешние сущности, но на них нужно ссылаться вDTD - делая их бесполезными для моих усилий, так как нет никакого DTD, сгенерированного phpdoc, и я не хочу включать файл для каждого класса и метода вручную.

1 Ответ

0 голосов
/ 10 июня 2010

Во-первых, если это действительно docbook 5, вам нужно «xml» перед «id» следующим образом: 

<chapter xml:id="package.default">

Во-вторых, вы можете использовать каталог XML для хранения всех ссылок на сущности: http://www.sagehill.net/docbookxsl/Catalogs.html

...