qtcreator-doxygen 插件技术文档

qtcreator-doxygen 插件技术文档

qtcreator-doxygen Doxygen Plugin for Qt Creator 项目地址: https://gitcode.com/gh_mirrors/qt/qtcreator-doxygen

1. 安装指南

1.1 编译插件

要编译 qtcreator-doxygen 插件，您需要安装与目标 Qt Creator 版本相同的 Qt 版本。您可以在 Qt Creator 的“关于”菜单中查看所需的 Qt 版本。

1.1.1 下载并提取 Qt Creator 源码

从官方网站下载并提取 Qt Creator 的源码。

1.1.2 编译 Qt Creator

使用正确的 Qt 工具包编译 Qt Creator 源码。在 Linux 系统上，您可以指向官方的二进制发布版本，该版本通常位于您的主文件夹中。

1.1.3 编译插件

您有两种编译插件的方式：

使用 Qmake

• 通过 QTC_SOURCE 和 QTC_BUILD 变量指定 Qt Creator 的源码路径和二进制路径。
• QTC_SOURCE 必须指向您提取的源码。
• QTC_BUILD 必须指向您的构建文件夹（或在 Linux 上的二进制发布版本）。
• 使用 USE_USER_DESTDIR=yes 选项可以自动安装模块。
• 示例命令：qmake USE_USER_DESTDIR=yes QTC_SOURCE=~/src/qt-creator-opensource-src-4.5.0 QTC_BUILD=~/qtcreator-4.5.0。

使用 Qt Creator

• 通过编辑 doxygen.pro 文件来指定 Qt Creator 的源码路径和二进制路径。
• 您需要更改 QTCREATOR_SOURCES 和 IDE_BUILD_TREE 变量。

1.2 安装插件

如果您编译了插件，它将自动安装。如果您下载了二进制发布版本，请按照以下路径进行安装：

• Unix: ~/.local/share/data/QtProject/qtcreator/plugins/<version>
• OSX: ~/Library/Application Support/QtProject/Qt Creator/plugins/<version>
• Windows: %LOCALAPPDATA%\QtProject\qtcreator\plugins\<version>

将 <version> 替换为您的 Qt Creator 版本（例如：4.8.0）。

2. 项目使用说明

qtcreator-doxygen 是一个为 Qt Creator 开发的 Doxygen 插件。该插件为 Qt Creator 添加了一些功能，如项目文件选择对话框和重复块检测。

2.1 功能概述

• 文件选择对话框：允许用户选择项目中的文件进行 Doxygen 文档生成。
• 重复块检测：自动检测代码中的重复块，并提供警告。

2.2 使用步骤

1. 启动 Qt Creator。
2. 打开您的项目。
3. 使用插件提供的功能生成 Doxygen 文档。

3. 项目API使用文档

qtcreator-doxygen 插件提供了一些 API 接口，用于与 Qt Creator 进行交互。以下是一些常用的 API 接口：

3.1 文件选择对话框 API

• void selectFiles(const QStringList &files)：选择指定的文件列表进行 Doxygen 文档生成。
• QStringList getSelectedFiles()：获取当前选择的文件列表。

3.2 重复块检测 API

• void detectDuplicateBlocks(const QString &filePath)：检测指定文件中的重复代码块。
• QList<QPair<int, int>> getDuplicateBlocks()：获取检测到的重复代码块列表。

4. 项目安装方式

4.1 编译安装

按照上述编译指南进行编译，编译完成后插件将自动安装。

4.2 二进制安装

从项目的发布页面下载二进制发布版本，并按照上述安装路径进行安装。

---

通过以上步骤，您可以成功安装并使用 qtcreator-doxygen 插件，为您的 Qt Creator 项目生成 Doxygen 文档。

qtcreator-doxygen Doxygen Plugin for Qt Creator 项目地址: https://gitcode.com/gh_mirrors/qt/qtcreator-doxygen