API 文档
本项目的 API 文档由 mkdocstrings 从源码
自动生成——页面上看到的内容就是代码里的文档字符串,因此不会出现
"文档和实现不一致"。
怎么读这些页面
每个页面左上角的标题形如 tkflu.button · FluButton 按钮,
正文按 模块 → 类 → 方法 的层级展开,可以折叠。
带 源码 折叠块的条目可以直接看到实现。
分组说明
| 分组 | 内容 |
|---|---|
| 组件 Widgets | 你日常使用的那些控件 |
| 窗口 Windows | 主窗口、子窗口与窗口外观管理 |
| 基础设施 Core | 常量、便捷函数、主题管理、图标、渲染入口 |
| 设计规范 Designs | 配色、几何、渐变、动画参数 |
建议的阅读顺序
关于文档覆盖率
文档字符串仍在补齐中。目前"组件"与"基础设施"两组覆盖率较高,
designs 组的部分模块说明较短——如果你发现某个 API 没有说明,
欢迎直接补文档字符串,页面会自动更新。
顺便说句,一个人写注释、文档太难了😭