autogsdoc - 云端在线

程序：

您的姓名

autogsdoc - GNUstep API 文档生成器和 XML->HTML 转换器

概要

自动文档 [-文件 文件名[-生成Html 是|否[-干净的 是|否[- 清洁模板
是|否[-忽略依赖项 是|否[-MakeDependency 是|否[-显示依赖项 是|否]
[-标头目录 径[-文档目录 径[-声明 地址[-项目
标题[-标准 是|否[-DocumentAllInstanceVariables 是|否]
[-文档实例变量 是|否[-InstanceVariablesAtEnd 是|否[-常量模板
文件名[- 函数模板 文件名[-宏模板 文件名[-Typedefs模板
文件名[- 变量模板 文件名[-系统项目 绳子[-本地项目 绳子]
[-项目 字典字符串[-详细 是|否[-警告 是|否[-词图 字典字符串] [档]

商品描述

autogsdoc 工具是一个命令行实用程序，可帮助开发人员生成参考
GNUstep API 的文档。 它还使开发人员能够编写和维护其他
XML 格式的文档并将其转换为 HTML。 详细来说，autogsdoc 将：

- 提取描述类、类别的公共接口的特殊注释，
来自 Objective C 源代码的协议、函数和宏（头文件和
可选的源文件）转换为 GSDoc XML 文件。

- 转换 GSDoc XML 文件，无论是从源代码生成还是由手动编写
开发人员，转换为 HTML。

- 基于 GSDoc XML 文件集构建索引，并将其转换为 HTML。

最常见的用法是使用一个或多个头文件名运行命令
参数 ... 该工具会自动解析相同的源文件
目录作为标题（或当前目录，或使用
DocumentationDirectory 默认），并生成 GSDoc 和 HTML 文件作为输出。 最好的
结果此模式应从包含源文件的目录中运行。 （笔记
因为 C 是 Objective C 的一个子集，所以这个工具可以操作来记录函数和
普通 C 源代码中的其他 C 结构。）

GSDoc文件也可以直接附加或者自己给，会被转换
到 HTML。 请参阅 GSDoc HTML 文档或 文档(7) 手册页获取有关信息的信息
GSDoc 格式。

最后，可以在命令行上给出 HTML 文件。 对其他部分的交叉引用
在其中找到的代码文档将根据在其中找到的内容进行重写
当前项目。

源 守则 标记

源代码解析器将自动生成 GSDoc 文档，其中列出了
在源文件中找到的类，它将包含来自特殊格式的文本
来自源文件的注释。

任何以斜杠和开头的评论 二 星号而不是常见的斜线和单
星号，被认为是 GSDoc 标记，用作类或方法的描述
跟随它。 此注释文本被重新格式化，然后插入到输出中。
当多个评论与同一个项目相关联时，它们用一个
越线 （ ) 之间如有必要。

该工具可以很容易地用于记录程序和库，只需提供它
包含程序的 main() 函数的源文件的名称 - 它需要
来自该函数的特殊注释并特殊处理它们，将它们作为
文档第一章末尾的部分（如果
必要的）。

可选项 在部分中描述 参数 和 默认值 联络一位教师

额外服务 标记

在某些情况下会执行特殊的额外处理，主要是在
在源文件中找到的第一个注释，可以从中找到各种 GSDoc 标记
提取并放置在输出文档中的适当位置 -

Autogsdoc来源：
在任何行中 Autogsdoc来源： 找到，该行的其余部分被视为
要使用的源文件名，而不是假设每个 .h 文件
处理使用同名的 .m 文件。 您可以提供多个 Autogsdoc来源：
头文件声明在多个源文件中定义的项目的行。
如果文件名是绝对的，则按提供的方式使用。 如果另一方面，它是一个
相对路径，软件首先相对于位置查找源文件
头文件，如果在那里找不到，相对于当前目录
autogsdoc 正在运行，最后相对于指定的目录
文档目录 默认。


文档内容的摘要...放置在 GSDoc 输出的头部。


代码作者的描述 - 可能会重复以处理以下情况
文档有多个作者。 放置在 GSDoc 输出的头部。 作为帮助
源代码的可读性，执行一些特殊的附加处理
文档作者 - 任何形式的“作者：姓名”行'，或 '由：
姓名', 或 'Author: name' 或 'By: name' 将被识别并且
转换为 作者 元素，可能包含一个 email 元件。


放置在 GSDoc 输出中，就在文档正文结尾之前 - 预期
用于附录、索引等。


紧接在任何生成的类文档之前放置......打算使用
提供对被记录的代码如何工作的总体描述。 任何
程序的 main() 函数的文档作为一个部分插入到最后
本章的。


文档内容的版权...置于 GSDoc 输出的头部。
为了提高源代码的可读性，一些特殊的附加处理是
执行 - 任何“版权（C）文本”形式的行都将被识别和转换
到 复制 元件。


文件的修订日期...置于 GSDoc 输出的头部。 如果
省略了该工具将尝试从 RCS 日期标记构造一个值（如果
可用）。


在正文的开头插入到文档中......旨在提供
介绍或目录页等。


文档的标题...放置在 GSDoc 输出的头部。 如果省略这个
该工具将生成自己的（可能很差）标题 - 所以你应该包括这个
手动标记。


文档的版本标识符 ... 放置在 GSDoc 输出的头部。 如果
省略了该工具将尝试从 RCS Revision 标签构造一个值（如果
可用）。

NB 刚刚描述的标记可以在类、类别或协议文档中使用
...如果是这样，它会被提取出来并包裹在该类的其余文档中
作为班级的章节。 类文档的其余部分通常插入
本章的结尾，但可以代替伪
内的元素元素。

方法 标记

在用于为方法描述提供文本的注释中，以下标记是
从文本中删除并特别处理 -


该方法被标记为类的指定初始化程序。


该方法被标记为子类必须覆盖的方法（例如抽象
方法）。


该方法被标记为子类应该 不是 覆盖。


标记从描述中删除并放置 after 它在 GSDoc 输出中 -
以便将该方法描述为符合（或不符合）指定的
标准认证

计算机自动 标记

通常，评论中的文本会重新格式化以使其标准化并很好地缩进......
重新格式化是 而不去 对内部的任何文本执行元素。 当文字是
重新格式化后，它被分解为空格分隔的“单词”，然后对其进行处理
一些额外的处理...

某些众所周知的常量，例如 YES、NO 和 nil 包含在...
标记。

方法描述中方法参数的名称包含在...
</ VAR> 标记。

方法名称（以加号或减号开头）包含在...
标记。 例如，“-init”（不带引号）将包含在 GSDoc 引用中
指向当前类的 init 方法的元素，或者，如果只有一个已知类
有一个 init 方法，它会引用那个类的方法。 请注意以下事实
方法名称必须被空格包围才能被识别（尽管是逗号，
句号或说明符末尾的分号将充当空格）。

方法说明符，包括类名（以方括号开头和结尾）
被封闭在... 标记。 例如'[NSObject-init]'，将创建一个
对 NSObject 的 init 方法的引用（正确的类，或其任何一个
category)，而 '[(NSCopying)-copyWithZone:]'，则创建对方法的引用
NSCopying 协议。 注意方括号之间不能出现空格
在这些说明符中。 协议名称括在圆括号中，而不是
习惯用尖括号，因为 GSDoc 是一种 XML 语言，而 XML 对待角
特别括号。

'main()' 以外的函数名（以 '()' 结尾）包含在...
标记。 例如“NSLogv()”（不带引号）将被包裹在一个 GSDoc 中
引用元素指向 NSLog 函数的文档。 注意事实
函数名必须用空格包围（尽管逗号、句号或
说明符末尾的分号也将充当空白终止符）。

争论 AND 默认值

该工具接受某些用户默认值（当然可以作为命令行提供
通过在默认名称前加上“-”并在其后给出值来传递参数，如
- 清洁是）：

清洁
如果此布尔值设置为 YES，则不是生成文档，而是
工具删除项目中生成的所有GSDoc文件，以及所有生成的html文件
从它们（以及从列出的 GSDoc 文件生成的任何
显式），最后删除项目索引文件。 唯一的例外
是模板 GSDoc 文件（即那些使用“-ConstantsTemplate ...”指定的文件，
“-FunctionsTemplate ...” 参数等）不会被删除，除非 CleanTemplates
标志已设置。

清洁模板
此标志指定模板 GSDoc 文件是否与其他
指定 Clean 选项时的文件。 默认是不删除它们
...因为这些模板可能是手动生成的，只是插入了数据
进入他们。

常量模板
指定模板文档的名称，其中有关常量的文档
应该从项目中的所有文件中插入。 如果常量在
源代码分散在许多文件中，您需要将它们归为一个
地方。 您有责任确保基本模板文档（放入其中的
单独的常量文档被插入）包含您的所有其他信息
想要，但为了方便，autogsdoc 将生成一个简单的模板（您可以
如果文件不存在，则为您编辑）。 立即插入
前 背部 元素（或者，如果不存在，则紧接在
身体 元素）在模板中。

声明
指定要记录标题的位置。 产生的实际名称
在文档中是通过附加头文件名的最后一部分形成的
到这个默认值。 如果未指定此默认值，则全名
头文件（在命令行中提供），默认为 HeaderDirectory
前置，使用。 一个典型的用法可能是“-Declared Foundation”，当
为 GNUstep 基础库生成文档。 这将导致
文档说 NSString 在“Foundation/NSString.h”中声明

文档所有实例变量
此标志允许您为所有实例变量生成文档。 一般，
只有那些明确声明为“公共”或“受保护”的才会被记录下来。

文档实例变量
此标志允许您完全关闭实例变量的文档。
通常，显式声明的“public”或“protected”实例变量将是
记录下来。

实例变量结束
如果设置此标志，则指示 HTML 生成器放置实例变量文档
在课程结束时，而不是开始时。 如果您使用大量
受保护的实例变量只是次要的兴趣
类的一般用户。

文档目录
可用于指定要放置生成的文档的目录。
如果未设置，则输出将放置在当前目录中。 这个目录也是
用作定位源文件（不是标题）的最后手段，更重要的是，它
用作 第一 和 仅由 诉诸于定位传递的任何 .gsdoc 文件
命令行。 为这些文件提供的任何路径信息都是 去除 它们是
在“DocumentationDirectory”中搜索（即使它们可能没有被
自动生成）。

档
指定包含文件名列表作为属性列表数组的文件名
（姓名 1，姓名 2，...） 格式。 如果存在，程序参数列表中的文件名
被忽略并且此文件中的名称用作要处理的名称列表。

函数模板
指定模板文档的名称，其中有关函数的文档
应该从项目中的所有文件中插入。 如果函数源，这很有用
代码分散在许多文件中，您需要将它们组合到一个地方。 你是
负责确保基本模板文件（个人
插入函数文档）包含您想要的所有其他信息，但是
为方便起见，autogsdoc 将生成一个简单的模板（然后您可以对其进行编辑）
如果文件不存在，则为您。 插入发生在紧接在 背部
元素（或者，如果不存在，则紧接在 身体 元素）在
模板。

生成HTML
可用于指定是否要生成 HTML 输出。 默认为是。

头目录
可用于指定要搜索头文件的目录。 供货时，
此值附加到相对标头名称，否则为相对标头名称
相对于当前目录进行解释。 指定为绝对的头文件
路径不受此默认值的影响。

忽略依赖
一个布尔值，可用于指定程序应忽略文件
修改时间并重新生成文件。 提供配合使用
'make' 系统，它应该自行管理依赖项检查。

本地项目
该值用于控制将本地外部项目自动包含到
在最终文档输出中生成交叉引用的索引系统。 如果
设置为“无”，则不进行本地项目引用，否则，“本地”
GNUstep 文档目录递归搜索带有“.igsdoc”的文件
扩展名，并使用来自这些文件的索引信息。 这的价值
字符串也用于生成交叉引用中的文件名......如果它是一个
空字符串，假设要使用的路径是在同一目录中的文件
igsdoc 文件被找到，否则它被用作索引中名称的前缀。 注意。
与当前记录的项目同名的本地项目将 而不去
纳入该机制。 如果您希望包含此类项目，则必须这样做
明确使用 -项目 ...

宏模板
指定模板文档的名称，有关宏的文档应包含在该模板文档中
从项目中的所有文件中插入。 如果宏代码分散，这很有用
围绕许多文件，您需要将其分组到一个地方。 你负责
确保基本模板文件（个别宏文件
插入）包含您想要的所有其他信息，但为了方便
autogsdoc 将为您生成一个简单的模板（然后您可以对其进行编辑），如果
文件不存在。 插入发生在紧接在 背部 元素（或如果
不存在的，紧接在结束之前 身体
元素）在模板中。

建立依赖关系
用于输出 make 的依赖信息的文件名。 这将采取
列出项目已知的所有头文件和源文件作为依赖项的形式
项目名称（参见“项目”）。

项目
可用于指定此项目的名称...确定索引的名称
作为文档的一部分生成的参考文件提供信息
其他项目以交叉引用本项目中的项目。

项目
该值可以作为包含 igsdoc 路径的字典提供
外部项目使用的索引/参考文件，以及用于映射的值
在索引中找到的文件名。 例如，如果一个项目索引 (igsdoc) 文件
表示在文件 'Foo' 中找到了类 'Foo'，以及与
那个项目索引是'/usr/share/doc/proj'，那么生成的html输出可以参考
该类在 '/usr/share/doc/prj/Foo.html' 中。 请注意，字典可能是
使用标准的 PropertyList 格式（不是 XML
OS X 格式），使用分号作为行分隔符，并将其括在单个
引号。

显示依赖项
一个布尔值，可用于指定程序应记录哪些文件
正在重新生成，因为它们依赖于其他文件。

标准
一个布尔值，用于指定程序是否应插入有关
标准合规性写入文档。 这应该只在以下情况下使用
记录 GNUstep 库和工具本身，因为它假定代码
被记录是 GNUstep 的一部分，可能符合 OpenStep 标准
或实现 MacOS-X 兼容方法。

系统项目
该值用于控制系统外部项目自动包含到
在最终文档输出中生成交叉引用的索引系统。 如果
设置为“无”，则不进行系统项目引用，否则，“系统”
GNUstep 文档目录递归搜索带有“.igsdoc”的文件
扩展名，并使用来自这些文件的索引信息。 这的价值
字符串也用于生成交叉引用中的文件名......如果它是一个
空字符串，假设要使用的路径是在同一目录中的文件
igsdoc 文件被找到，否则它被用作索引中名称的前缀。 注意。
与当前记录的项目同名的系统项目将 而不去
纳入该机制。 如果您希望包含此类项目，则必须这样做
明确使用 -项目 ...

类型定义模板
指定模板文档的名称，有关 typedefs 的文档应放入该模板文档中
从项目中的所有文件中插入。 如果 typedef 源代码是
散布在许多文件中，您需要将其分组到一个地方。 你是
负责确保基本模板文件（个人
typedef 文档被插入）包含您想要的所有其他信息，但作为
一个方便的 autogsdoc 将生成一个简单的模板（然后您可以编辑）
你如果文件不存在。 插入发生在紧接在 背部
元素（或者，如果不存在，则紧接在 身体 元素）在
模板。

Up 用于提供要在生成的 GSDoc 的“up”链接中使用的名称的字符串
文件。 这通常应该是包含索引的文件的名称
一个项目的内容。 如果缺少此项或设置为空字符串，则没有 'up'
链接将在文件中提供。

变量模板
指定模板文档的名称，其中有关变量的文档
应该从项目中的所有文件中插入。 如果可变源，这很有用
代码分散在许多文件中，您需要将它们组合到一个地方。 你是
负责确保基本模板文件（个人
变量文档被插入）包含您想要的所有其他信息，但是
为方便起见，autogsdoc 将生成一个简单的模板（然后您可以对其进行编辑）
如果文件不存在，则为您。 插入发生在紧接在 背部
元素（或者，如果不存在，则紧接在 身体 元素）在
模板。

详细
一个布尔值，用于指定是否需要详细的调试/警告输出
生产的。

警告
一个布尔值，用于指定是否需要标准警告输出（例如报告
未记录的方法）产生。

字图
该值是一个字典，用于映射在源文件中找到的标识符/关键字
换句话说。 通常您不必使用它，但有时它会有所帮助
避免解析器被 C 预处理器宏的使用混淆。 你可以
有效地将宏重新定义为不那么令人困惑的东西。 您映射的值
标识符必须是以下之一 - 另一个标识符，空字符串 - 值是
忽略，两个斜线 ('//') - 该行的其余部分被忽略。 注意字典
可以在命令行上使用标准的 PropertyList 格式（不是
OS X 的 XML 格式），使用分号作为行分隔符，并将其包含在单个
引号。

文件间 连锁

'Up' 默认用于指定应该用作
使用的任何其他文档的“向上”链接。 此名称不得包含路径或扩展名。
一般这个默认引用的文档应该是手工编辑的GSDoc文档
它应该有一个包含项目索引的后部。 例如


<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.3//EN"
"http://www.gnustep.org/gsdoc-1_0_3.xml">


我的项目参考




我的项目参考

使用 onworks.net 服务在线使用 autogsdoc