# 14.5. 文档

## 14.5.1. 目录

要想通过设置使文档浏览器documentation browser 正常工作, KDevelop 需要一些 关于HTML -documentation在系统上位置的信息。因此, 文档路径属性对话需要 HTML 中Qt-在线文档的路径及到KDE-库文档的路径。

通常, Qt-文档Qt-Documentation 位于Qt安装的相同目录中；例如，如果Qt位于 /usr/local/qt, 你必须输入的路径即为/usr/local/qt/html。对于KDE-文档, 你必须将目 录设置为文档的根部, 确保所有的KDE-库文档位于相同的目录中。两个路径都可以通过按 下相关按钮, 显示路径设置来选择。如果你的系统部包含KDE-库文档, 你应该限输入下一 个设置对话configuration dialog , 升级KDE文档 KDE-Documentation 。这会 按你选择的路径生成文档,并自动设置KDE库文档路径。

## 14.5.2. 选项

### 14.5.2.1. 升级KDE-Documentation

对于那些没有近期KDE 库KDE-libraries 的用户, 尤其是安装在系统上的文件的文档, 升级的KDE 文档KDE-Documentation 对话会生成一个新的或升级已有的文档。这一 功能要求你的系统已经安装了KDoc 及qt2KDoc , 包含于KDE-SDK 包内。 首先, 你必须设置你近期kde库资源的路径, 这不是包含KDE的路径! 只需输入资源的路径, 比如:/home/rnolden/kdelibs-1.1/.

接着, 你可以选择三种不同的安装模式, 如下:

- 删除旧文档并安装于近期的文档路径: 这假定你已经安装了一个文档且位于输入文 档路径对话的路径下。这将删除所有文档并安装新生成的文档到近期路径。

- 删除旧文档并安装于新的文档路径: 这会导致象上一种模式一样删除旧文档, 但你 可以选择建立一个新的文档地点。

- 不改变旧文档并安装于新的文档路径:推荐那些以前没有该文档或希望为老版本的 kde库保留上一个文档的用户生成一个新的kde库文档时使用。

"新的 KDE 库文档路径"将为第二和第三种安装模式设置。推荐从头开始生成新文档的用户 使用。 在按下OK 按钮后, Kdevelop会在包含KDoc 参考文件的文档路径中生成一个子目录 "KDoc -reference" 。首先, qt库文档classes 将被索引以由将为kde库生成 的文档来连接Qt文档。因此你应该先设置好Qt文档路径以确保它可以由`qt2kdoc` 找到，这一点很重要。最后, KDE库将被索引，文档将前后对照着建立，以使浏览具有更强 大的功能。

### 14.5.2.2. 创建搜寻数据库

创建查找数据库对话, 可通过建立按钮进入, 它允许编程人员创建数据库以交互的方式查找 关键字。要创建和使用文档查找功能, 你必须先安装glimpse 4.0 程序。事先调整索 引给定的KDE 库文档及Qt-Documentation 的选项, 假定文档文件的路径已在选项菜 单的 "文档路径"对话中设置。另外，索引可以包括用户可以通过" 另外的索引目录" 域自 行设置的目录。在设置好另外的目录的路径后, 必须按下"增加" 按钮以设置路径。一个以 前设置的路径可以通过在路径域选择路径并按下"去除"从索引中去除。此外, 用户可以选择 三种不同的索引尺寸: 极小的, 小型的以及中型的。索引尺寸越大, 索引文件越长。 但是, 更 大的查寻数据库中的查寻会更加快捷, 因此我们推荐使用"中等" 尺寸。要使用查找功能， 请参见 使用文档浏览器.