Whiteboard-Docs

声网互动白板（Interactive Whiteboard）文档仓库，用于生成 Whiteboard SDK 和 Fastboard SDK 全平台（Web、iOS 和 Android）的发版说明和 API 参考文档。

仓库概述

这是一个纯文档仓库，不直接开发代码。仓库中的代码文件仅用于从代码注释生成 API 文档。

工作流程

1. 同步代码：从其他 SDK 开发仓库同步最新版本的代码到本仓库
2. 更新注释：为新增的对外 API 添加详细的代码注释
3. 生成文档：使用平台特定的文档工具从代码注释生成 API 参考文档

支持的平台和 SDK

平台

• Web - JavaScript/TypeScript
• iOS - Objective-C/Swift
• Android - Java/Kotlin

SDK 类型

• Whiteboard SDK - 基础白板 SDK
• Fastboard SDK - 快速集成白板 SDK

仓库结构

Whiteboard-Docs/
├── web/                    # Web 平台文档
│   ├── Whiteboard/         # Whiteboard SDK for Web
│   │   ├── CN/            # 中文文档
│   │   └── EN/            # 英文文档
│   └── Fastboard/         # Fastboard SDK for Web
│       ├── CN/            # 中文文档
│       └── EN/            # 英文文档
├── ios/                    # iOS 平台文档
│   ├── Whiteboard/         # Whiteboard SDK for iOS
│   │   ├── CN/            # 中文文档
│   │   └── EN/            # 英文文档
│   └── Fastboard/         # Fastboard SDK for iOS
│       ├── CN/            # 中文文档
│       └── EN/            # 英文文档
└── android/                # Android 平台文档
    ├── Whiteboard/         # Whiteboard SDK for Android
    │   ├── CN/            # 中文文档
    │   └── EN/            # 英文文档
    └── Fastboard/         # Fastboard SDK for Android
        ├── CN/            # 中文文档
        └── EN/            # 英文文档

文档类型

Fastboard SDK

• 发版说明：使用 MDX 格式编写
• API 参考：使用 MDX 格式编写
• 语言支持：中文（CN）和英文（EN）

Whiteboard SDK

• 发版说明：使用 MDX 格式编写
• API 参考：使用平台特定的文档工具从代码注释生成：
  • Web：TypeDoc（TypeScript）
  • iOS：AppleDoc（Objective-C）
  • Android：Doxygen（Java）
• 语言支持：中文（CN）和英文（EN）

文档生成工具

Web 平台

• TypeDoc：从 TypeScript 类型定义文件生成 API 文档
• 配置文件：web/Whiteboard/CN/config/typedoc.json、web/Whiteboard/EN/config/typedoc.json

iOS 平台

• AppleDoc：从 Objective-C 头文件生成 API 文档
• 配置文件：ios/Whiteboard/CN/headers/AppledocSettings.plist、ios/Whiteboard/EN/headers/AppledocSettings.plist

Android 平台

• Doxygen：从 Java 源代码生成 API 文档
• 配置文件：android/Whiteboard/CN/Doxyfile、android/Whiteboard/EN/Doxyfile

使用指南

对于文档编写者

更新发版说明

1. 在对应平台的 Fastboard/ 或 Whiteboard/ 目录下找到发版说明文件
2. 使用 MDX 格式编写新的版本更新内容
3. 确保中英文版本内容一致

更新 API 文档

1. 同步代码：从 SDK 开发仓库同步最新代码
2. 添加注释：为新增的 API 添加详细的代码注释
3. 生成文档：运行对应的文档生成工具
   • Web：npm run doccn 或 npm run docen
   • iOS：使用 AppleDoc 工具
   • Android：使用 Doxygen 工具

对于开发者

1. 导航到目标平台目录（web/、ios/ 或 android/）
2. 选择 SDK 类型（Whiteboard/ 或 Fastboard/）
3. 选择语言版本（CN/ 或 EN/）
4. 查看对应的文档和发版说明

注意事项

• 本仓库不直接开发代码，仅用于文档生成
• 代码文件的存在是为了从注释生成 API 文档
• 所有发版说明都使用 MDX 格式编写
• 确保中英文文档内容保持一致
• 遵循各平台的文档工具使用规范

贡献指南

请参考各平台目录下的具体贡献指南和开发设置说明。

许可证

[在此添加许可证信息]