Update documentation

Author: ggzgli

build_docs.sh

@@ -23,14 +23,11 @@ NC='\033[0m' # No Color
 
 # 清理函数
 cleanup() {
-    # 恢复 .docc 目录
-    if [ -n "$DOCC_BACKUP" ] && [ -d "$DOCC_BACKUP" ]; then
-        echo -e "${BLUE}恢复 .docc 目录...${NC}"
-        mv "$DOCC_BACKUP" "$DOCC_DIR"
-    fi
+    echo -e "${BLUE}执行清理操作...${NC}"
 
     # 清理临时文件
     if [ -d "./DerivedData" ]; then
+        echo -e "${BLUE}清理临时构建文件...${NC}"
         rm -rf ./DerivedData
     fi
 }
@@ -39,7 +36,8 @@ cleanup() {
 trap cleanup EXIT INT TERM
 
 echo -e "${GREEN}=== AtomicXCore 文档生成工具 ===${NC}"
-echo -e "${BLUE}模式: 完整 API 文档（自动生成所有 public 符号）${NC}"
+echo -e "${BLUE}模式: 基于 target 生成完整 API 文档（自动生成所有 public 符号）${NC}"
+echo -e "${BLUE}Target: ${TARGET_MODULE}${NC}"
 echo ""
 
 # 清理旧文档
@@ -48,14 +46,10 @@ if [ -d "$OUTPUT_DIR" ]; then
     rm -rf "$OUTPUT_DIR"
 fi
 
-# 临时重命名 .docc 目录以生成完整的 API 文档
+# 完全跳过 .docc 目录处理
 DOCC_BACKUP=""
-if [ -d "$DOCC_DIR" ]; then
-    echo -e "${BLUE}临时禁用 .docc 目录以生成完整 API 文档...${NC}"
-    echo -e "${BLUE}（这样可以让 DocC 自动包含所有 public 类、结构体、枚举等）${NC}"
-    DOCC_BACKUP="${DOCC_DIR}.backup"
-    mv "$DOCC_DIR" "$DOCC_BACKUP"
-fi
+echo -e "${BLUE}配置文档生成模式：基于 target 生成完整 API 文档${NC}"
+echo -e "${BLUE}策略：保持 .docc 目录不变，让系统自动处理构建错误${NC}"
 
 # 查找 .xcodeproj 或 .xcworkspace
 if [ -n "$WORKSPACE_OR_PROJECT" ]; then
@@ -79,25 +73,62 @@ fi
 echo -e "${GREEN}使用项目: $WORKSPACE_OR_PROJECT${NC}"
 echo ""
 
+# 验证项目状态
+echo -e "${BLUE}验证项目状态...${NC}"
+if [ -d "$DOCC_DIR" ]; then
+    echo -e "${BLUE}.docc 目录存在: $DOCC_DIR${NC}"
+    echo -e "${BLUE}构建可能会尝试编译 .docc，但我们会忽略相关错误${NC}"
+else
+    echo -e "${GREEN}✓ .docc 目录不存在，将生成纯 API 文档${NC}"
+fi
+
 # 构建文档（设置 hosting base path）
+echo ""
 echo -e "${GREEN}开始构建文档...${NC}"
+echo -e "${BLUE}构建参数:${NC}"
+echo -e "  项目: $WORKSPACE_OR_PROJECT"
+echo -e "  Scheme: $SCHEME_NAME"
+echo -e "  Base Path: /$HOSTING_BASE_PATH"
+echo ""
+
+# 使用 xcodebuild 构建项目，但跳过文档编译错误
+echo -e "${BLUE}执行构建命令...${NC}"
+BUILD_RESULT=0
 xcodebuild docbuild \
     $BUILD_FLAG "$WORKSPACE_OR_PROJECT" \
     -scheme "$SCHEME_NAME" \
     -destination 'generic/platform=iOS' \
     -derivedDataPath ./DerivedData \
-    DOCC_HOSTING_BASE_PATH="/$HOSTING_BASE_PATH"
+    DOCC_HOSTING_BASE_PATH="/$HOSTING_BASE_PATH" \
+    2>&1 || BUILD_RESULT=$?
+
+# 即使构建部分失败，也检查是否生成了 .doccarchive
+if [ $BUILD_RESULT -ne 0 ]; then
+    echo -e "${YELLOW}构建过程中出现错误（可能是 .docc 编译错误），但继续检查输出...${NC}"
+fi
 
 echo ""
 echo -e "${GREEN}查找生成的文档归档...${NC}"
 
 # 查找生成的 .doccarchive（优先查找目标模块的文档）
-DOCC_ARCHIVE=$(find ./DerivedData -path "*/AtomicXCore/AtomicXCore.doccarchive" | head -1)
+echo -e "${BLUE}搜索 ${TARGET_MODULE}.doccarchive 文件...${NC}"
+
+# 显示所有找到的 .doccarchive 文件
+echo -e "${BLUE}所有可用的 .doccarchive 文件:${NC}"
+ALL_ARCHIVES=$(find ./DerivedData -name "*.doccarchive")
+echo "$ALL_ARCHIVES" | while read archive; do
+    if [ -n "$archive" ]; then
+        echo -e "  ${archive}"
+    fi
+done
+
+# 优先选择路径中含有目标模块名的 .doccarchive
+DOCC_ARCHIVE=$(echo "$ALL_ARCHIVES" | grep "/${TARGET_MODULE}/${TARGET_MODULE}.doccarchive" | head -1)
 
-# 如果没找到，尝试其他路径
+# 如果没找到，选择任何名为目标模块的 .doccarchive
 if [ -z "$DOCC_ARCHIVE" ]; then
-    echo -e "${YELLOW}未在标准路径找到，搜索所有 ${TARGET_MODULE}.doccarchive...${NC}"
-    DOCC_ARCHIVE=$(find ./DerivedData -name "${TARGET_MODULE}.doccarchive" | head -1)
+    echo -e "${YELLOW}未找到标准路径，搜索所有 ${TARGET_MODULE}.doccarchive...${NC}"
+    DOCC_ARCHIVE=$(echo "$ALL_ARCHIVES" | grep "${TARGET_MODULE}.doccarchive" | head -1)
 fi
 
 if [ -z "$DOCC_ARCHIVE" ]; then

docs/data/documentation/atomicxcore.json

@@ -1 +1 @@
-{"topicSections":[{"title":"Enumeration Cases","identifiers":["doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/allowAny","doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/denyAny","doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/needConfirm"],"generated":true,"anchor":"Enumeration-Cases"},{"title":"Initializers","identifiers":["doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/init(rawValue:)"],"generated":true,"anchor":"Initializers"},{"title":"Type Methods","identifiers":["doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/fromV2TIMAllowType(_:)"],"generated":true,"anchor":"Type-Methods"},{"title":"Default Implementations","identifiers":["doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/Equatable-Implementations","doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/RawRepresentable-Implementations"],"generated":true,"anchor":"Default-Implementations"}],"relationshipsSections":[{"kind":"relationships","title":"Conforms To","identifiers":["doc:\/\/org.cocoapods.AtomicXCore\/s12CaseIterableP","doc:\/\/org.cocoapods.AtomicXCore\/SQ","doc:\/\/org.cocoapods.AtomicXCore\/SH","doc:\/\/org.cocoapods.AtomicXCore\/SY"],"type":"conformsTo"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AllowType"}],"languages":["swift"],"platforms":["iOS"]}]}],"metadata":{"navigatorTitle":[{"text":"AllowType","kind":"identifier"}],"externalID":"s:11AtomicXCore9AllowTypeO","roleHeading":"Enumeration","symbolKind":"enum","title":"AllowType","role":"symbol","modules":[{"name":"AtomicXCore"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AllowType","kind":"identifier"}]},"variants":[{"paths":["\/documentation\/atomicxcore\/allowtype"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"identifier":{"url":"doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType","interfaceLanguage":"swift"},"abstract":[{"text":"Friend verification method.","type":"text"}],"kind":"symbol","references":{"doc://org.cocoapods.AtomicXCore/documentation/AtomicXCore/AllowType/init(rawValue:)":{"type":"topic","identifier":"doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/init(rawValue:)","url":"\/documentation\/atomicxcore\/allowtype\/init(rawvalue:)","title":"init(rawValue:)","abstract":[],"role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"rawValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"kind":"symbol"},"doc://org.cocoapods.AtomicXCore/SQ":{"identifier":"doc:\/\/org.cocoapods.AtomicXCore\/SQ","title":"Swift.Equatable","type":"unresolvable"},"doc://org.cocoapods.AtomicXCore/documentation/AtomicXCore/AllowType/needConfirm":{"url":"\/documentation\/atomicxcore\/allowtype\/needconfirm","kind":"symbol","role":"symbol","title":"AllowType.needConfirm","identifier":"doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/needConfirm","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"needConfirm","kind":"identifier"}],"type":"topic","abstract":[{"text":"Need confirmation.","type":"text"}]},"doc://org.cocoapods.AtomicXCore/documentation/AtomicXCore/AllowType/allowAny":{"url":"\/documentation\/atomicxcore\/allowtype\/allowany","kind":"symbol","role":"symbol","title":"AllowType.allowAny","identifier":"doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/allowAny","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"allowAny","kind":"identifier"}],"abstract":[{"type":"text","text":"Allow anyone."}],"type":"topic"},"doc://org.cocoapods.AtomicXCore/documentation/AtomicXCore/AllowType/denyAny":{"identifier":"doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/denyAny","type":"topic","title":"AllowType.denyAny","role":"symbol","url":"\/documentation\/atomicxcore\/allowtype\/denyany","abstract":[{"text":"Deny anyone.","type":"text"}],"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"denyAny","kind":"identifier"}],"kind":"symbol"},"doc://org.cocoapods.AtomicXCore/SY":{"type":"unresolvable","title":"Swift.RawRepresentable","identifier":"doc:\/\/org.cocoapods.AtomicXCore\/SY"},"doc://org.cocoapods.AtomicXCore/documentation/AtomicXCore/AllowType":{"title":"AllowType","url":"\/documentation\/atomicxcore\/allowtype","navigatorTitle":[{"text":"AllowType","kind":"identifier"}],"role":"symbol","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Friend verification method."}],"identifier":"doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AllowType","kind":"identifier"}]},"doc://org.cocoapods.AtomicXCore/documentation/AtomicXCore/AllowType/fromV2TIMAllowType(_:)":{"role":"symbol","type":"topic","kind":"symbol","abstract":[{"text":"Convert V2TIMFriendAllowType to AllowType.","type":"text"}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"fromV2TIMAllowType"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"c:@E@V2TIMFriendAllowType","text":"V2TIMFriendAllowType"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:11AtomicXCore9AllowTypeO","text":"AllowType"}],"identifier":"doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/fromV2TIMAllowType(_:)","title":"fromV2TIMAllowType(_:)","url":"\/documentation\/atomicxcore\/allowtype\/fromv2timallowtype(_:)"},"doc://org.cocoapods.AtomicXCore/SH":{"title":"Swift.Hashable","identifier":"doc:\/\/org.cocoapods.AtomicXCore\/SH","type":"unresolvable"},"doc://org.cocoapods.AtomicXCore/documentation/AtomicXCore/AllowType/Equatable-Implementations":{"identifier":"doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/Equatable-Implementations","title":"Equatable Implementations","abstract":[],"type":"topic","url":"\/documentation\/atomicxcore\/allowtype\/equatable-implementations","kind":"article","role":"collectionGroup"},"doc://org.cocoapods.AtomicXCore/documentation/AtomicXCore":{"kind":"symbol","abstract":[],"type":"topic","role":"collection","identifier":"doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore","title":"AtomicXCore","url":"\/documentation\/atomicxcore"},"doc://org.cocoapods.AtomicXCore/documentation/AtomicXCore/AllowType/RawRepresentable-Implementations":{"identifier":"doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/RawRepresentable-Implementations","title":"RawRepresentable Implementations","abstract":[],"kind":"article","url":"\/documentation\/atomicxcore\/allowtype\/rawrepresentable-implementations","type":"topic","role":"collectionGroup"},"doc://org.cocoapods.AtomicXCore/s12CaseIterableP":{"type":"unresolvable","title":"Swift.CaseIterable","identifier":"doc:\/\/org.cocoapods.AtomicXCore\/s12CaseIterableP"}}}
+{"identifier":{"url":"doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType","interfaceLanguage":"swift"},"abstract":[{"text":"Friend verification method.","type":"text"}],"relationshipsSections":[{"identifiers":["doc:\/\/org.cocoapods.AtomicXCore\/s12CaseIterableP","doc:\/\/org.cocoapods.AtomicXCore\/SQ","doc:\/\/org.cocoapods.AtomicXCore\/SH","doc:\/\/org.cocoapods.AtomicXCore\/SY"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AllowType"}],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/atomicxcore\/allowtype"]}],"metadata":{"navigatorTitle":[{"text":"AllowType","kind":"identifier"}],"role":"symbol","symbolKind":"enum","modules":[{"name":"AtomicXCore"}],"title":"AllowType","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AllowType","kind":"identifier"}],"externalID":"s:11AtomicXCore9AllowTypeO","roleHeading":"Enumeration"},"kind":"symbol","topicSections":[{"identifiers":["doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/allowAny","doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/denyAny","doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/needConfirm"],"generated":true,"anchor":"Enumeration-Cases","title":"Enumeration Cases"},{"identifiers":["doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/init(rawValue:)"],"generated":true,"anchor":"Initializers","title":"Initializers"},{"identifiers":["doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/fromV2TIMAllowType(_:)"],"generated":true,"anchor":"Type-Methods","title":"Type Methods"},{"identifiers":["doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/Equatable-Implementations","doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/RawRepresentable-Implementations"],"generated":true,"anchor":"Default-Implementations","title":"Default Implementations"}],"hierarchy":{"paths":[["doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore"]]},"references":{"doc://org.cocoapods.AtomicXCore/documentation/AtomicXCore/AllowType/init(rawValue:)":{"abstract":[],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"rawValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"kind":"symbol","url":"\/documentation\/atomicxcore\/allowtype\/init(rawvalue:)","role":"symbol","type":"topic","title":"init(rawValue:)","identifier":"doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/init(rawValue:)"},"doc://org.cocoapods.AtomicXCore/documentation/AtomicXCore/AllowType/RawRepresentable-Implementations":{"identifier":"doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/RawRepresentable-Implementations","title":"RawRepresentable Implementations","kind":"article","role":"collectionGroup","type":"topic","abstract":[],"url":"\/documentation\/atomicxcore\/allowtype\/rawrepresentable-implementations"},"doc://org.cocoapods.AtomicXCore/SY":{"identifier":"doc:\/\/org.cocoapods.AtomicXCore\/SY","type":"unresolvable","title":"Swift.RawRepresentable"},"doc://org.cocoapods.AtomicXCore/SQ":{"identifier":"doc:\/\/org.cocoapods.AtomicXCore\/SQ","type":"unresolvable","title":"Swift.Equatable"},"doc://org.cocoapods.AtomicXCore/documentation/AtomicXCore/AllowType/needConfirm":{"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"needConfirm","kind":"identifier"}],"title":"AllowType.needConfirm","abstract":[{"type":"text","text":"Need confirmation."}],"url":"\/documentation\/atomicxcore\/allowtype\/needconfirm","kind":"symbol","identifier":"doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/needConfirm","role":"symbol","type":"topic"},"doc://org.cocoapods.AtomicXCore/documentation/AtomicXCore/AllowType":{"kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AllowType"}],"title":"AllowType","abstract":[{"type":"text","text":"Friend verification method."}],"type":"topic","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"AllowType"}],"url":"\/documentation\/atomicxcore\/allowtype","identifier":"doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType"},"doc://org.cocoapods.AtomicXCore/documentation/AtomicXCore":{"url":"\/documentation\/atomicxcore","identifier":"doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore","title":"AtomicXCore","type":"topic","kind":"symbol","abstract":[],"role":"collection"},"doc://org.cocoapods.AtomicXCore/SH":{"identifier":"doc:\/\/org.cocoapods.AtomicXCore\/SH","type":"unresolvable","title":"Swift.Hashable"},"doc://org.cocoapods.AtomicXCore/documentation/AtomicXCore/AllowType/fromV2TIMAllowType(_:)":{"url":"\/documentation\/atomicxcore\/allowtype\/fromv2timallowtype(_:)","type":"topic","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"fromV2TIMAllowType"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"V2TIMFriendAllowType","preciseIdentifier":"c:@E@V2TIMFriendAllowType"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"AllowType","preciseIdentifier":"s:11AtomicXCore9AllowTypeO"}],"abstract":[{"type":"text","text":"Convert V2TIMFriendAllowType to AllowType."}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/fromV2TIMAllowType(_:)","title":"fromV2TIMAllowType(_:)"},"doc://org.cocoapods.AtomicXCore/documentation/AtomicXCore/AllowType/allowAny":{"type":"topic","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"allowAny"}],"role":"symbol","abstract":[{"text":"Allow anyone.","type":"text"}],"title":"AllowType.allowAny","kind":"symbol","identifier":"doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/allowAny","url":"\/documentation\/atomicxcore\/allowtype\/allowany"},"doc://org.cocoapods.AtomicXCore/documentation/AtomicXCore/AllowType/denyAny":{"abstract":[{"type":"text","text":"Deny anyone."}],"kind":"symbol","type":"topic","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"denyAny","kind":"identifier"}],"url":"\/documentation\/atomicxcore\/allowtype\/denyany","identifier":"doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/denyAny","title":"AllowType.denyAny","role":"symbol"},"doc://org.cocoapods.AtomicXCore/s12CaseIterableP":{"identifier":"doc:\/\/org.cocoapods.AtomicXCore\/s12CaseIterableP","type":"unresolvable","title":"Swift.CaseIterable"},"doc://org.cocoapods.AtomicXCore/documentation/AtomicXCore/AllowType/Equatable-Implementations":{"url":"\/documentation\/atomicxcore\/allowtype\/equatable-implementations","type":"topic","title":"Equatable Implementations","role":"collectionGroup","identifier":"doc:\/\/org.cocoapods.AtomicXCore\/documentation\/AtomicXCore\/AllowType\/Equatable-Implementations","abstract":[],"kind":"article"}}}