API Reference

Overview

本项目是一个名为 clore 的 C++ 库，旨在利用大型语言模型（LLM）来自动探索代码库并生成结构化指南文档。其核心子系统包括：智能代理（agent 模块）驱动 LLM 交互与工具调用的主循环；LLM 通信层（client、network、http、protocol 模块）提供与 OpenAI 和 Anthropic 等提供者的异步请求、响应解析及协议适配；文档生成（generate、extract 模块）负责从源代码提取符号、分析依赖并生成最终文档页面；配置与 schema（config、schema 模块）管理应用设置并自动为 C++ 类型生成兼容的 JSON Schema；以及 支持工具（support 模块）提供 Unicode 文本处理、文件读写、路径规范化等基础能力。读者可将该库视为一个端到端的文档自动编写框架，各模块围绕“代码理解→LLM 调用→文档产出”这一主线解耦协作，上层可灵活组合协议层与生成策略以适配不同 LLM 服务与输出格式。

Modules

• agent
• agent:tools
• anthropic
• client
• config
• config:load
• config:normalize
• config:schema
• config:validate
• extract
• extract:ast
• extract:cache
• extract:compiler
• extract:filter
• extract:merge
• extract:model
• extract:scan
• generate
• generate:analysis
• generate:cache
• generate:common
• generate:diagram
• generate:dryrun
• generate:evidence
• generate:markdown
• generate:model
• generate:page
• generate:planner
• generate:scheduler
• generate:symbol
• http
• network
• openai
• protocol
• provider
• schema
• support

Namespaces

• clore
• clore::agent
• clore::config
• clore::extract
• clore::extract::cache
• clore::generate
• clore::generate::cache
• clore::logging
• clore::net
• clore::net::anthropic
• clore::net::anthropic::detail
• clore::net::anthropic::protocol
• clore::net::anthropic::protocol::detail
• clore::net::anthropic::schema
• clore::net::detail
• clore::net::openai
• clore::net::openai::detail
• clore::net::openai::protocol
• clore::net::openai::protocol::detail
• clore::net::openai::schema
• clore::net::openai::schema::detail
• clore::net::protocol
• clore::net::schema
• clore::support

Module Dependency Diagram