как создать PHPDoc Учебник/Расширенные страницы, чтобы дополнить комментировал код

Question

Я пытаюсь все, что могу, чтобы получить PhpDocumentor, чтобы позволить мне использовать формат учебник DocBook в дополнение к документации, он создает:

1. Я использую Затмение
2. Я установил PhpDocumentor через PEAR на машине OSX
3. я могу запустить и автоматически генерировать код из моих классов PHP
4. Это не формат Учебники - Я не могу найти решение

Я пробовал перемещать файл примера .pkg по всей структуре файла, в подпапках, используя аналогичное имя для пакета, на который ссылается код. Я действительно в недоумении - если кто-то может объяснить WHERE они помещают .pkg и другие файлы DocBook по отношению к коду они документируют и как они вызывают PHPDoc форматировать его, я был бы признателен, я использую это на данный момент:

phpdoc -o HTML:Smarty:HandS 
-d "/path/to/code/classes/", "/path/to/code/docs/tutorials/" 
-t /path/to/output 

Answer 1

Я не ожидал, что будет отвечать на свой вопрос, но после 2 дней ума от боли изгиба и выходные экспериментировать, кажется, это проблема:

Учебник и мои примеры должны работать, но , кажется, есть незначительный недостаток в способе, которым phpdoc интерпретирует значения переключателя. Вот то, что я использую:

phpdoc -o HTML:Smarty:HandS 
-d "/path/to/code/classes/", "/path/to/code/docs/tutorials/" 
-t /path/to/output 

Однако, если вы используете следующий:

phpdoc -o HTML:Smarty:HandS 
-d /path/to/code/classes/, /path/to/code/docs/tutorials/ 
-t /path/to/output 

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

Проблема решена.

Answer 2

вы читали this ?

Предлагается следующая схема маршрута: tutorials/package/package.pkg где package - это имя вашего пакета, вы сделали это так?

Answer 3

Да, использование двойных кавычек, вероятно, отбросило разбор аргументов внутренней среды phpDocumentor, вызывая -d /path/to/code/classes как одну пару аргументов/значений, не включая /path/to/code/docs/tutorials в качестве дополнительного значения каталога.

Как правило, я видел две другие проблемы, связанные с созданием учебников. Во-первых, каталог учебника не соответствует ожидаемому phpDocumentor. Два, никакие фактические файлы кода PHP не включены в выполнение. Я помню, как добавлял формулировку к руководству, конкретно for these two scenarios.

Answer 4

Я столкнулся с той же проблемой, используя конфигурацию .ini для конфигурации, но проблема заключалась в том, что я помещал промежуток между запятой и каталогом, что привело к тому, что каталог не привязан к -d параметр.

Не работает:

directory = {$lib}/Question,{$lib}/Error, {$path}/docs/tutorials 

Рабочая:

directory = {$lib}/Question,{$lib}/Error,{$path}/docs/tutorials 

Надежда это решает проблему для кого-то другого!