cxref - 云端在线

程序：

您的姓名

cxref -C 交叉引用和文档编制工具。

概要

外部参照 文件名 [ ... 文档名称] [-O目录名] [-N基本名] [-R基本名] [-所有评论]
[-暂无评论] [-逐字评论] [-块-评论]
[-外部参照[-all][-file][-func][-var][-type]] [-警告[-全部][-评论][-外部参照]]
[-索引[-全部][-文件][-func][-var][-类型]] [-生的] [-乳胶] [-html[-src]] [-rtf] [-sgml]
[-一世目录名] [-D定义] [-U定义] [-CPP cpp_程序] [-- cpp_args ... cpp_args]

外部参照 文件名 [ ... 文档名称] -删除 [-O目录名] [-N基本名] [-R基本名]

商品描述

一个可以自动为 C 生成文档和交叉引用的程序
程序。

输入是任何带有适当注释的 C 程序，输出是 LaTeX、HTML、RTF 或
SGML 文件。

配置

文件名
要记录的文件的名称，一次可以记录任意数量的文件。

-删除
命名的文件将从输出目录中删除，它们在
交叉引用数据库和主要输出文件将被删除。

-奥迪纳姆
用于输出 Latex 文件的目录名称和文件夹的位置
创建的交叉引用文件。

-N基名
用于输出和交叉引用文件第一部分的名称
cxref 的文件扩展名保持不变。

-R目录名
当源文件在多个目录中时，将 dirname 设置为
源树的根目录（如果更容易使用相对路径，例如`-R../ ..“）。
这将从该根目录运行 cxref 并且`-Odirname'必须是
相对于那个目录。

-所有评论
如果您认为现有的评论可能有效，（请参阅上面的说明
特别评论）。 [危险！ 这个选项会产生奇怪的结果。]

-暂无评论
忽略所有注释，如果您只想要交叉引用而不是
文档。

-逐字评论
当您在代码中的注释按预定样式格式化时
要保留在输出中，此选项将强制它们不被
重新格式化。 [注意，这仅用于文件和函数注释。]

-块评论
当程序中的注释被格式化为“块”样式（带有前导
'*' 字符在每一行），此选项将从
输出。 [适用于单个‘*’、‘+’、‘|’ 或`:'在每一行。]

-外部参照 产生交叉引用信息（见下文）。
-all 所有交叉引用。
-file 文件的交叉引用。
-func 函数的交叉引用。
-var 变量的交叉引用。
-type 类型的交叉引用。

-警告 产生警告，选项必须连接在一起：
-all 所有警告。
-comment 警告丢失的评论。
-xref 警告缺少交叉引用。

-指数 生成交叉引用索引，选项必须连接在一起：
-all 所有索引。
-file 文件索引。
-func 函数索引。
-var 变量索引。
-type 类型索引。

-生的 生成原始形式的输出，除了使用 -warn 外，没有多大用处。

-乳胶 生成一个 LaTeX 文件来记录每个源文件和一个额外的文件
包括这些文件中的每一个。

-html 生成一个 HTML 4.01 文件来记录每个源文件和一个主文件
参考这些文件中的每一个。

-html-src
生成 HTML 输出和带有链接的源文件的 HTML 版本。

-rtf 生成富文本格式 (RTF) 文件来记录源文件。

-sgml 生成一个 SGML 文件来记录源文件。 （使用 LinuxDoc DTD）。

-伊迪尔名称
GCC 选项指定包含文件的路径。

-D定义
用于定义预处理器符号的 GCC 选项。

-udefine
取消定义预处理器符号的 GCC 选项。

-CPP 程序
要使用的程序名称，而不是编译时默认值。 该程序
必须能够执行`gcc -E -C -dD' 所做的所有操作。 如果
该程序需要参数，然后整个事情需要用引号引起来，以便它
被解释为 cxref 的单个参数。

--ARG ... ARG
传递给预处理器的额外参数可以放在“--”之后
分隔器。

C 编译器 更换 外部参照-cc
为了简化在现有源代码上使用 cxref，现在有一个 shell 脚本可以
调用 C 编译器，然后调用 cxref 来处理源文件。 这意味着它
可以用作 Makefile 等中 CC 的替代品。

用法：cxref-cc [常用 cc 选项]

源文件的名称是从选项列表以及`-D*'中提取的，
`-I*'、`-U*' 标志以及当 C 编译器成功退出时 cxref 将被调用。 这
要使用的 C 编译器的名称由 CXREFCC 环境变量控制，或者如果
这不是设置然后是 CC 环境变量，或者只是 gcc 失败。

使用此脚本需要使用“.cxref”配置文件来包含选项
因为没有地方可以在 C 编译器的命令行上放置选项。

这只会交叉引用和记录 C 源文件，因为它们是唯一的
那些被编译的，但它会确保它们与
正确的选项等。

外部参照 配置 文件
这些命令行参数也可以放在名为“.cxref”的文件中，而不是放在
命令行。 当 cxref 运行时，程序的参数在
按照顺序。

(1) 命令行上的那些。 (2) 当前目录中`.cxref'文件中的那些。
(3) 由`-R'指定的源树根中`.cxref'文件中的那些。

这意味着在多目录源树中，每个子目录都可以有一个“.cxref”
仅包含行“-R..”或适当的文件。 主目录可以有一个
`.cxref' 文件包含剩余的选项。 这完全消除了需要
除了源文件名之外，在命令行上还有任何选项。

`.cxref' 文件的格式是任意数量的行，每行包含一个
命令行参数（相当于 argv 之一）。 唯一不能的选项
使用的是源文件本身的名称和`-delete' 选项。 空行是
忽略和以“#”开头的行是注释。

曲目 配套文档 评论
该程序的文档是根据代码中的注释生成的
格式正确。 交叉引用来自代码本身，不需要
加班。

特殊注释是`/**** ****/'（对于文件）和`/*++++ ++++*/'（对于数据
object) 可以在标准的“/*”和“*/”注释中使用任意数量的“*”或“+”
注释中的分隔符，它们将被忽略。

如果注释行以空格开头，后跟“+html+”，则其余部分
行仅包含在 HTML 输出中，不会被处理，因此它可以包含 HTML
标记，`-html-' 表示该行的其余部分包含在除 HTML 之外的所有内容中
输出。 这同样适用于其他输出格式，`+none+' 可用于行
不出现在任何输出中。 对此的例外是原始输出不执行任何操作
检查并将输出所有行。

在任何情况下，注释跟在“,”、“;”之后或 ')' 仅由空格和
标签，注释被推到标点符号之前以应用于那里的对象。

该程序是使用带有一些 GCC 扩展的完整 ANSI C 语法解析器实现的，
这意味着代码的风格不重要，只有内容和注释。

USB和Thunderbolt Cross 引用
对以下项目执行交叉引用

档
当前文件包含的文件
（即使通过其他文件包含）。

#包括
当前文件中包含的文件。
这些文件中包含的文件等。

变量
定义外部变量的位置。
具有全局变量可见性的文件。
使用变量的文件/函数。

主要工作内容
函数原型所在的文件。
函数调用的函数。
调用函数的函数。
引用函数的文件和函数。
函数中使用的变量。

这些项目中的每一个都在输出中交叉引用。

交叉引用使用文件“cxref.variable”、“cxref.function”、“cxref.include”和
`cxref.typedef' 在输出目录中。 这些是功能的完整列表和
程序中的变量用法，可用于生成函数调用层次结构或
例如变量使用图。 每个文件需要两次 cxref 传递，第一个传递
建立交叉引用文件和第二个使用它们。

（如果使用了‘-N’选项，文件名会不同。）

胶乳 输出
默认的 LaTeX 输出是每个源文件的一个文件，并带有一个额外的文件
`cxref.tex' 包含每个其他文件。 这是为了只允许 makefile
更新更改的文件（尽管引用可能需要所有文件
再次检查）。 写入 cxref.tex 文件后，用户可以对其进行修改，
添加的任何新文件都添加在源代码部分的末尾，其余部分
文件不变。

索引被写入一个名为“cxref.apdx.tex”的文件中，并且 cxref.tex 被更新以引用
到它。

还写出三个 LaTeX 样式文件 `page.sty'、`fonts.sty' 和 `cxref.sty'。
这些设置页面使用较小的边距和较小的字体，以允许更多内容出现在
一个页面，并定义用于排版 cxref 输出的新命令。

（如果'-N'选项是
用过的。）

HTML 输出
默认的 HTML 输出是每个源文件的一个文件和一个额外的文件
`cxref.html' 包含每个其他文件。 这是为了只允许 makefile
更新更改的文件（尽管引用可能需要所有文件
再次检查）。 写入 cxref.html 文件后，用户可以对其进行修改，
添加的任何新文件都添加到目录之前的末尾，其余的
文件不变。

索引被写入一个名为“cxref.apdx.html”的文件中，并且 cxref.html 被更新以引用
到它。

（如果`-N'选项是
用过的。）

HTML 输出使用 HTML 4.01 标准并且所有页面都正确验证。

RTF格式 输出
Rich Text Format 是一种由 Microsoft 设计的相当低级的页面描述格式。 它
不像其他格式那样是一个定义明确且易于理解的标准，但它是
流行于文件交换。

每个源文件和一个索引文件都有一个输出文件。

SGML 输出
由于 SGML 是一种元语言，因此有必要定义布局元素以及
提供信息。 cxref 输出使用 LinuxDoc 文档格式，并且是
设计用于 SGMLtools 程序（http://www.sgmltools.org/).

每个源文件和一个索引文件都有一个输出文件。

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