包简介

Task for ApiGen, a tool for creating professional API documentation from PHP source code.

README 文档

README

Task for ApiGen, a tool for creating professional API documentation from PHP source code.

This is a read-only split of https://github.com/phingofficial/phing/tree/main/src/Phing/Task/Ext/ApiGen.

Please report issues and send Pull Requests in the main Phing repository.

Attributes

Name	Type	Description	Default	Required
executable	String	ApiGen executable name.	apigen	No
action	String	ApiGen action to be executed.	generate	No
config	String	Config file name.	n/a	Source and destination are required - either set explicitly or using a config file. Attribute values set explicitly have precedence over values from a config file.
source	String	List of source files or directories.	n/a
destination	String	Destination directory.	n/a
exclude	String	List of masks (case sensitive) to exclude files or directories from processing.	n/a	No
skipdocpath	String	List of masks (case sensitive) to exclude elements from documentation generating.	n/a	No
charset	String	Character set of source files.	UTF-8	No
main	String	Main project name prefix.	n/a	No
title	String	Title of generated documentation.	n/a	No
baseurl	String	Documentation base URL.	n/a	No
googlecseid	String	Google Custom Search ID.	n/a	No
googlecselabel	String	Google Custom Search label.	n/a	No
googleanalytics	String	Google Analytics tracking code.	n/a	No
templateconfig	String	Template config file name.	n/a	If not set the default template is used.
templatetheme	String	Template theme file name.	n/a	If not set the default template is used.
accesslevels	String	Element access levels. Documentation only for methods and properties with the given access level will be generated.	public, protected	No
internal	Boolean	Whether to generate documentation for elements marked as internal and internal documentation parts or not.	No	No
php	Boolean	Whether to generate documentation for PHP internal classes or not.	Yes	No
tree	Boolean	Whether to generate tree view of classes, interfaces, traits and exceptions or not.	Yes	No
deprecated	Boolean	Whether to generate documentation for deprecated elements or not.	No	No
todo	Boolean	Whether to generate documentation of tasks or not.	No	No
sourcecode	Boolean	Whether to generate highlighted source code files or not.	Yes	No
download	Boolean	Whether to generate a link to download documentation as a ZIP archive or not.	No	No
debug	Boolean	Whether to enable the debug mode or not.	No	No

Example

<apigen
  source="classes"
  destination="api"
  exclude="*/tests/*"
  title="My Project API Documentation"
  deprecated="true"
  todo="true"/>

phing/task-apigen 适用场景与选型建议

phing/task-apigen 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 86.95k 次下载、GitHub Stars 达 1，最近一次更新时间为 2019 年 12 月 31 日，在 PHP 生态内属于活跃度较高的组件。

我们在过去多个企业项目中使用过 phing/task-apigen 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 phing/task-apigen 我们能提供哪些服务？

定制开发 / 二次开发

基于 phing/task-apigen 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

phing/task-apigen

包简介

README 文档

README

Attributes

Example

phing/task-apigen 适用场景与选型建议

统计信息

GitHub 信息

其他信息