docs: 补充注释、修正过时文档、清理重复内容

源码注释:
- 为 ~60 个 Swift 文件补充缺失的 doc comment(file header、类型、属性、方法)
- 修正 4 处错误注释:翻页模式数量、搜索行为描述、手势识别器描述、悬空文档块

文档维护:
- 删除重复文档:WXRead/读书EPUB阅读器实现架构.md(与微信读书版完全一致)
- 合并重叠文档:阅读器规划.md → 阅读器功能开发计划.md(单一真值)
- 修正过时内容:所有文档中"四种翻页模式"→"三种",移除 horizontalCoverScroll
- 更新架构图:补齐 EPUBUI/ReaderController、Paging/、Typesetter/ 等子目录
- 更新 index.md 索引:新增开发计划和架构对比文档引用
This commit is contained in:
shen
2026-06-01 09:33:23 +08:00
parent 1efb9d172f
commit 948004eed1
56 changed files with 1691 additions and 792 deletions
@@ -1,10 +1,12 @@
import UIKit
/// UITextView UIMenuItem
/// UITextView
/// UIMenuItem `onSelectionAction`
final class RDEPUBSelectableTextView: UITextView {
///
///
var onSelectionAction: ((RDEPUBAnnotationMenuAction) -> Void)?
///
override func canPerformAction(_ action: Selector, withSender sender: Any?) -> Bool {
switch action {
case #selector(rd_copy(_:)),
@@ -1,7 +1,13 @@
import UIKit
///
///
final class RDEPUBTextAnnotationOverlay: RDEPUBSelectionOverlayView {
///
/// - Parameters:
/// - highlights:
/// - content:
/// - page:
/// - contentBaseOffset:
func applyHighlights(
_ highlights: [RDEPUBHighlight],
to content: NSMutableAttributedString,
@@ -38,6 +44,12 @@ final class RDEPUBTextAnnotationOverlay: RDEPUBSelectionOverlayView {
}
}
///
/// - Parameters:
/// - content:
/// - page:
/// - searchState:
/// - contentBaseOffset:
func applySearchHighlights(
to content: NSMutableAttributedString,
page: RDEPUBTextPage,
@@ -65,6 +77,13 @@ final class RDEPUBTextAnnotationOverlay: RDEPUBSelectionOverlayView {
}
}
/// 线
/// - Parameters:
/// - page:
/// - highlights:
/// - searchState:
/// - interactionController:
/// - Returns:
func buildDecorations(
page: RDEPUBTextPage,
highlights: [RDEPUBHighlight],
@@ -1,4 +1,5 @@
import UIKit
///
///
/// RDEPUBSelectionOverlayView
final class RDEPUBTextPageDecorationView: RDEPUBSelectionOverlayView {}