**QtCreator Doxygen插件安装与配置完全指南**

QtCreator Doxygen插件安装与配置完全指南

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

项目基础介绍

QtCreator Doxygen插件是为广受欢迎的集成开发环境Qt Creator量身打造的文档生成工具。该插件基于LGPL-2.1许可协议，允许开发者在遵守一定条件的前提下自由使用、修改和分发。它最初由fpoussin维护的一个分支，专为最新版本的Qt Creator设计，并增加了文件选择对话框等功能，以及重复块检测，以提高文档生成的便利性和准确性。

主要编程语言：

• C++
• QMake（用于构建过程）

关键技术和框架

• Doxygen: 项目的核心依赖之一，用于解析源代码并生成结构化的文档。
• Qt Creator: 目标IDE平台，提供了良好的扩展机制让插件可以无缝集成。
• QMake: 构建系统，用于编译和管理Qt相关的项目，包括此插件本身。
• LGPL-2.1许可: 保障了项目的开源和免费使用，同时也要求衍生作品遵循特定的开放规则。

安装和配置步骤

准备工作

1. 确保环境: 需要安装相应版本的Qt Creator和Qt库，版本应与插件构建时一致。检查Qt Creator的“关于”菜单获取当前版本信息。
2. 下载源码: 访问项目页面，点击“Clone or download”并选择“Download ZIP”，解压至适合的目录。

编译安装插件（适用于有编译环境的用户）

步骤1: 设置环境变量（可选）

对于Linux，如果你选择使用Qmake，设置QTC_SOURCE和QTC_BUILD环境变量指向Qt Creator的源代码路径和构建目录。

export QTC_SOURCE=/path/to/qt-creator-source
export QTC_BUILD=/path/to/build-directory

步骤2: 使用Qmake编译

在命令行中进入插件源码目录，执行以下命令来编译插件：

qmake USE_USER_DESTDIR=yes QTC_SOURCE=$QTC_SOURCE QTC_BUILD=$QTC_BUILD
make

如果你不改变.pro文件中的路径，则需手动调整qtc_doxygen.pro中的QTCREATOR_SOURCES和IDE_BUILD_TREE。

步骤3: 安装插件

编译完成后，插件会被自动安装到相应的Qt Creator插件目录。若未自动安装，需手动将编译得到的.dll或.so文件移到以下位置：

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

记得替换<Qt Creator Version>为你实际的Qt Creator版本号。

下载预编译二进制安装

1. 访问项目的Releases页面，找到适用于你的Qt Creator版本的二进制文件。
2. 下载对应的插件包并解压缩。
3. 将解压得到的文件移动到上述提到的插件目录中。

启用插件

• 打开Qt Creator，进入“帮助”->“关于插件”，确保QtCreator Doxygen插件已启用。如果没有，勾选后重启Qt Creator。

至此，QtCreator Doxygen插件已经成功安装并准备就绪，你可以享受便捷的代码文档自动生成功能了。

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