Poxy：C++ 文档生成器指南

Poxy：C++ 文档生成器指南

poxy Documentation generator for C++ 项目地址: https://gitcode.com/gh_mirrors/po/poxy

1. 项目目录结构及介绍

Poxy 是一个基于 Doxygen 的 C++ 文档生成工具，它在 GitHub 上托管，仓库地址为 https://github.com/marzer/poxy.git。其项目结构遵循典型的 GitHub 工程布局，以下是主要目录和文件的简介：

• src: 包含 Poxy 的核心代码实现。
• tests: 测试案例存放地，用于确保 Poxy 功能的正确性。
• theme_sandbox: 可能是用来实验或存放定制化主题的目录。
• .clang-format, .editorconfig, .gitattributes, .gitignore, prettier.config.json: 这些是代码风格、版本控制和格式化的配置文件，保证代码的一致性和管理。
• CHANGELOG.md, CONTRIBUTING.md, LICENSE.txt, README.md: 分别记录了项目变更日志、贡献指南、许可证信息以及项目快速入门指南。
• pyproject.toml: 使用 Python Poetry 管理项目依赖和元数据的配置文件。
• 配置文件示例 (poxy.toml): 用户需创建此文件来配置 Poxy，以自定义生成文档的行为。

2. 项目启动文件介绍

尽管 Poxy 不直接提供一个“启动文件”来执行整个项目，但它的运行入口主要是通过命令行接口（CLI）实现的。用户应当安装 Poxy 后，通过 Python 的包管理系统调用 poxy 命令。具体来说，执行文档生成流程的关键在于正确配置 poxy.toml 文件后，通过命令行输入 poxy 命令（当配置文件位于当前工作目录时），或者指定配置文件路径 poxy path/to/poxy.toml 来启动文档生成过程。

3. 项目的配置文件介绍

poxy.toml 配置文件

配置文件 poxy.toml 是 Poxy 的心脏，它替代了传统的 Doxyfile，允许用户以 TOML 格式进行更简洁且易于维护的配置。关键配置项包括但不限于：

• 项目基本信息：比如项目名称、输出目录等。
• Doxygen 设置：间接控制 Doxygen 的行为，因为 Poxy 会在 Doxygen 的基础上进一步处理和美化结果。
• HTML 输出配置：主题选择（支持亮色、暗色或自定义）、是否生成HTML、是否启用错误作为警告等。
• 源码路径配置：定义源代码、图片和示例目录的递归或非递归处理方式。
• 语言特性：自动定义基于目标C++标准的语言宏。
• 额外功能：如集成cppreference的标签文件、自定义命令、语法高亮设置等。

示例配置片段可能看起来像这样：

[general]
output_dir = "html"

[doxygen]
# 示例：指定Doxygen的配置选项
input_dir = "src"

使用此配置文件，Poxy可以自动化地处理文档生成任务，根据用户的特定需求调整文档样式和内容。

---

以上就是对Poxy项目的基本结构、启动概述及配置文件的详细介绍。开发者通过仔细配置 poxy.toml 文件，并利用Poxy提供的强大功能，能够轻松生成专业级的C++项目文档。

poxy Documentation generator for C++ 项目地址: https://gitcode.com/gh_mirrors/po/poxy