2013-07-29 7 views
0

Я никогда раньше не использовал phpdoc, но я хочу, чтобы документы Authorize.Net PHP SDK и, похоже, мне нужно сгенерировать их с помощью phpdoc.phpdoc генерирует документы со сломанными ссылками и форматированием

Когда я бегу:

C:\Users\Owner\PhpstormProjects\CRM\anet_php_sdk>C:\Users\Owner\wamp\bin\php\php5.3.13\phpdoc -t phpdocs/ -d lib 

Я получаю поток «PARSING файла» и «Нет описания для метода», который я полагаю нормально. Список методов и параметров объектов будет достаточным, даже если нет описательного резюме.

Он заканчивается так:

Storing cache in "C:\Users\Owner\PhpstormProjects\CRM\anet_php_sdk\phpdocs" .. O K 
Load cache               .. 0.091 s 
Preparing template "responsive-twig"         .. 0.168 s 
Preparing 15 transformations           .. 0.000 s 
Build "elements" index            .. 0.017 s 
Replace textual FQCNs with object aliases       .. 0.214 s 
Build "packages" index            .. 0.025 s 
Build "namespaces" index and add namespaces to "elements"   .. 0.006 s 
Transform analyzed project into artifacts       .. 6.702 s 
Analyze results and write report to log        .. 0.005 s 

C:\Users\Owner\PhpstormProjects\CRM\anet_php_sdk> 

который я полагаю, также все в порядке.

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

Directory of C:\Users\Owner\PhpstormProjects\CRM\anet_php_sdk\phpdocs 

07/29/2013 03:20 PM <DIR>   . 
07/29/2013 03:20 PM <DIR>   .. 
07/29/2013 03:20 PM <DIR>   classes 
07/29/2013 03:20 PM   16,344 classes.svg 
07/29/2013 03:20 PM <DIR>   css 
07/29/2013 03:20 PM    5,713 deprecated.html 
07/29/2013 03:20 PM   100,054 errors.html 
07/29/2013 03:20 PM    5,717 graph_class.html 
07/29/2013 03:20 PM <DIR>   img 
07/29/2013 03:20 PM    7,528 index.html 
07/29/2013 03:20 PM <DIR>   js 
07/29/2013 03:20 PM    6,900 markers.html 
07/29/2013 03:20 PM <DIR>   namespaces 
07/29/2013 03:20 PM <DIR>   packages 
07/29/2013 03:20 PM <DIR>   phpdoc-cache-08 
07/29/2013 03:20 PM <DIR>   phpdoc-cache-2b 
07/29/2013 03:20 PM <DIR>   phpdoc-cache-2e 
07/29/2013 03:20 PM <DIR>   phpdoc-cache-48 
07/29/2013 03:20 PM <DIR>   phpdoc-cache-4f 
07/29/2013 03:20 PM <DIR>   phpdoc-cache-62 
07/29/2013 03:20 PM <DIR>   phpdoc-cache-64 
07/29/2013 03:20 PM <DIR>   phpdoc-cache-7a 
07/29/2013 03:20 PM <DIR>   phpdoc-cache-8c 
07/29/2013 03:20 PM <DIR>   phpdoc-cache-a3 
07/29/2013 03:20 PM <DIR>   phpdoc-cache-a6 
07/29/2013 03:20 PM <DIR>   phpdoc-cache-db 
07/29/2013 03:20 PM <DIR>   phpdoc-cache-e0 
       6 File(s)  142,256 bytes 
       21 Dir(s) 394,722,947,072 bytes free 

C:\Users\Owner\PhpstormProjects\CRM\anet_php_sdk\phpdocs> 

Кажется немного странным, что связка из кэша валяется, но все в порядке, я не знаю, чего ожидать от PHPDoc.

Однако - Фактические документы непригодны для использования. Индекс очень красивый и зеленый, и т. Д., Но каждая ссылка из индекса приводит меня к экрану, который неформатирован, и я сильно подозреваю, что отсутствует форматирование CSS.

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

Что я сделал не так?

+0

Хорошо, я не уверен, как я это сделал? Не знаю, что вы имеете в виду – Lurk21

ответ

2

Существует ошибка с шаблоном реагирующей ветви.
Я предлагаю вам попробовать шаблон как new-black

phpdoc --template=new-black -t phpdocs/ -d lib

Источник: Issue954

2

Ну, мне просто пришлось вручную переустановить весь выход phpdoc. Довольно неряшливый ИМХО.

Смежные вопросы