繁体   English   中英

phpdoc用断开的链接和格式生成文档

[英]phpdoc generating docs with broken links and formatting

我以前从未使用过phpdoc,但是我想要Authorize.Net PHP SDK文档,看来我需要使用phpdoc生成它们。

当我跑步时:

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

我得到了“解析文件”和“方法的无摘要”的信息流,我认为可以。 即使没有描述性摘要,也只需列出对象方法和参数即可。

结果如下:

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将所有文件放到错误的位置。 我已经尝试对它们进行整理以使其正常工作,但是无论我对输出文件进行多少重新排列,最终都需要进行更多重新排列。 此外,我不需要这样做。

我做错了什么?

好吧,我只需要手动重新排列所有的phpdoc输出。 相当草率恕我直言。

响应树枝模板存在错误。
我建议您尝试使用类似new-black的模板

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

资料来源: Issue954

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM