Docurium 技术文档

1. 安装指南

要安装 Docurium，请使用以下命令：

gem install docurium

确保您的系统中已经安装了 Ruby 和 Gem 包管理器。

2. 项目使用说明

Docurium 是一个轻量级的 Doxygen 替代品，它可以从 C 项目的头文件生成静态 HTML 文档。它旨在简单易用，支持 Git 标签，并且只记录公共接口，所以它仅处理头文件。

要使用 Docurium，首先需要创建一个配置文件。配置文件的格式如下：

{
  "name":   "项目名称",
  "github": "GitHub 仓库地址",
  "input":  "头文件所在目录",
  "prefix": "函数前缀（例如 git_）",
  "branch": "目标 Git 分支",
  "examples": "示例文件目录",
  "legacy":  {
    "input": {
      "旧版本目录": ["旧版本号"]
    }
  }
}

然后，运行 cm 可执行文件并传递你的 Docurium 配置文件：

cm 配置文件路径

Docurium 会处理你的头文件，生成文档，并将其写入指定的 Git 分支。

3. 项目 API 使用文档

Docurium 的 API 使用方式较为简单。它主要通过配置文件指定项目信息，然后通过以下命令生成文档：

cm 配置文件路径

在执行过程中，Docurium 会：

• 生成文档
• 处理不同版本
• 检查 API 文档中未匹配的参数和函数签名更改
• 将文档写入指定的 Git 分支

4. 项目安装方式

项目的安装方式已在“安装指南”部分说明，以下是简要步骤：

1. 确保系统已安装 Ruby 和 Gem 包管理器。
2. 使用以下命令安装 Docurium：

gem install docurium

安装完成后，您可以使用 cm 命令来生成文档。