apigen

原创
2013/03/14 14:19
阅读数 453
apigen --config <path> [options]
apigen --source <path> --destination <path> [options]

正如您可以看到的,您可以使用ApiGen要么通过提供单个参数通过命令行或使用一个配置文件。 此外你可以结合这两个方法和命令行参数将优先于那些在配置文件中。

每一个配置选项必须奉行的价值。 和它是完全相同的写 ——配置=文件配置 和 ——配置文件配置 。 唯一的例外是布尔选项(那些 是的|没有 值)。 当使用这些选项在命令行上你没有提供明确的“是”价值。 如果ommited,假设你想把选项。 所以使用 ——调试=是的 和 ——调试 并完全相同的(和相反的是吗 ——调试=没有 )。

一些选项可以有多个值。 为此,您可以使用它们多次或它们的值用逗号分开。 这意味着 ——源= file1。 php—源= php 和 ——源= file1 . php内,php 是完全相同的。

选项

--config|-c <file>

配置文件路径。

--source|-s <directory|file> required

路径目录或文件要处理。 您可以使用参数多次提供一个列表的目录或文件。 所有类型的PHAR归档的支持(需要PHAR扩展)。 处理广州/ bz2压缩档案你需要适当的扩展(参见需求)。

--destination|-d <directory> required

将生成的文档到这个目录。

--extensions <list>

允许的文件扩展名的列表,默认是“php”。

--exclude <mask>

目录和文件匹配这个文件面具不会解析。 你可以排除例如测试这种方式处理。 这个参数是大小写敏感的,可以多次使用。

--skip-doc-path <mask>
--skip-doc-prefix <value>

使用这个参数你可以告诉ApiGen不生成文档元素从某些文件或与某些名称前缀。 这些课程将会出现在类树木,但不会创建一个链接到他们的文档。 这些参数都是大小写敏感的,可以多次使用。

--charset <list>

字符集的源文件,默认是“自动”,让ApiGen选择所有支持的字符集。 但是如果你只使用一个字符设置在你的源文件你应该把它明确避免自动因为它可以棘手(并不是完全可靠)。 而且降低了处理的自动生成文档。 您还可以使用多次的参数提供一个列表的所有在你的文档中使用的字符集。 在这种情况下ApiGen将选择一个字符集的提供为每个文件。

--main <value>

这个名字前缀的元素将被视为“主要项目”(其余的将视为库)。

--title <value>

生成的文档的标题。

--base-url <value>

文档基本URL用于站点地图。 只需要如果你打算让你的文档公开。

--google-cse-id <value>

如果你有一个谷歌CSE ID、搜索框将用它当你不进入一个精确的类或函数名,不变。

--google-cse-label <value>

这将是默认的标签在使用谷歌CSE。

--google-analytics <value>

一个谷歌分析跟踪代码。 如果提供一个ansynchronous跟踪代码将进入每个生成的页面。

--template-config <file>

模板配置文件,默认是配置文件的ApiGen默认模板。

--allowed-html <list>

允许的HTML标记的列表在文档由逗号分隔。 默认值是 b,我,一个,ul,ol,李、磷、溴、var、玉米粥、kbd,tt

--groups <value>

应该如何在菜单元素分组。 可能的选项是“汽车”、“名称”、“包”和“无”。 默认值是“自动”(使用名称空间如果源代码使用它们,否则包)。

--autocomplete <list>

元素类型的列表将出现在搜索输入自动完成。 可能的值是“类”、“常量”、“功能”、“方法”、“属性”和“classconstants”。 默认值是“类、常量、功能”。

--access-levels <list>

访问级别的方法和属性,应该得到他们的文档解析。 默认值是 公共的、受保护的 (不产生私有类成员)。

--internal <yes|no>

生成的文档元素标记为内部( @internal 没有描述)和显示部分的文档标记为内部( @internal 与描述…… 或内联 { @internal…} ),默认是“不”。

--php <yes|no>

文档生成PHP内部类,默认是“是的”。

--tree <yes|no>

生成树视图类、接口、特征和异常,默认是“是的”。

--deprecated <yes|no>

生成文档弃用元素,默认是“不”。

--todo <yes|no>

生成一个任务列表,默认是“不”。

--source-code <yes|no>

生成的源代码高亮显示用户定义的元素,默认是“是的”。

--download <yes|no>

添加一个链接到下载文档作为一个ZIP归档文件,默认是“不”。

--report <file>

拯救一个checkstyle报告缺乏文档的元素到一个文件中。

--wipeout <yes|no>

删除文件生成的在前面跑,默认是“是的”。

--quiet <yes|no>

不打印任何信息到控制台,默认是“不”。

--progressbar <yes|no>

progressbar显示,默认是“是的”。

--colors <yes|no>

使用颜色,默认“不”在Windows上,“是的”在其他系统。 窗口不支持颜色在控制台然而您可以启用它Ansicon 

--update-check <yes|no>

检查新版本的ApiGen,默认是“是的”。

--debug <yes|no>

显示额外的信息(异常跟踪)在出错的情况下,默认是“不”。

--help|-h

显示列表可能的选项。

只有 ——源 和 ——目的地 参数都是必需的。 你可以提供通过命令行或者一个配置文件。

配置文件

而不是提供单个参数通过命令行,您可以准备一个配置文件,供以后使用。 你可以使用所有上面列出的参数(有一个例外: ——配置 选项)只是没有破折号和以一个大写字母之后的每一个破折号(所以 ——访问级别 变得 accessLevel )。

ApiGen使用 氖文件格式 所有的配置文件。 你可以试试 在线解析器 调试你的配置文件,看看他们如何得到解析。

然后你可以叫ApiGen用单一参数 ——配置 指定配置文件加载。

apigen --config <path> [options]

即使当使用一个配置文件,您仍然可以提供额外的参数通过命令行。 这样的参数将优先于配置文件的参数。

记住,任何配置文件中的值将 覆盖 从命令行值。 这意味着提供 ——源 参数值都在配置文件中,并通过命令行并不会导致使用所有提供的值,但只有那些从命令行。

如果你不能提供命令行参数,ApiGen将试图加载默认配置文件叫做 apigen.neon 在当前工作目录。 如果发现它将作为如果你使用了 ——配置 选项。 注意,当使用任何命令行选项,你必须指定配置文件,如果你有一个。 ApiGen将尝试自动加载一个只有当没有命令行参数使用。

选项名称必须在camelCase在配置文件( ——模板配置 在命令行上变得 templateConfig 在一个配置文件)。 你可以看到一个完整的列表的配置选项和短描述的示例配置文件 apigen.neon.example 

例子

我们正在生成文档。我们希望类树、列表的父类及其成员在列表的继承的属性、方法和常量。但是我们不希望产生他们的全部文档以及高亮显示源代码。和我们不需要处理任何“测试”目录,因为可能有类,不属于该项目实际。

apigen --source ~/nella/Nella --source ~/doctrine2/lib/Doctrine --source ~/doctrine2/lib/vendor --source ~/nette/Nette --skip-doc-path "~/doctrine2/*" --skip-doc-prefix Nette --exclude "*/tests/*" --destination ~/docs/ --title "Nella Framework"
展开阅读全文
打赏
0
1 收藏
分享
加载中
更多评论
打赏
0 评论
1 收藏
0
分享
返回顶部
顶部