Merge pull request #270 from p-x9/feature/macho-archive-docc

Documentation for `MachOArchiveKit`

Author: p-x9

.github/workflows/docc.yml

@@ -7,12 +7,12 @@ on:
 jobs:
   build:
     name: Generate DocC
-    runs-on: macos-15
+    runs-on: macos-26
     steps:
       - uses: actions/checkout@v3
 
-      - name: Select Xcode 16.4
-        run: sudo xcode-select -s /Applications/Xcode_16.4.app
+      - name: Select Xcode 26.3
+        run: sudo xcode-select -s /Applications/Xcode_26.3.app
 
       - name: Build DocC
         run: |
@@ -30,7 +30,7 @@ jobs:
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: macos-15
+    runs-on: ubuntu-latest
     steps:
       - name: Deploy to GitHub Pages
         id: deployment

Sources/MachOArchiveKit/Util/exported.swift

@@ -3,8 +3,13 @@
 //  MachOKit
 //
 //  Created by p-x9 on 2026/03/17
-//  
 //
+//
+
+@_documentation(visibility: internal)
+@_exported
+import MachOKit
 
-@_exported import MachOKit
-@_exported import ObjectArchiveKit
+@_documentation(visibility: internal)
+@_exported
+import ObjectArchiveKit

MachOKit.docc/MachOKit.md …/MachOKit/Documentation.docc/MachOKit.mdMachOKit.docc/MachOKit.md renamed to Sources/MachOKit/Documentation.docc/MachOKit.md MachOKit.docc/MachOKit.md renamed to Sources/MachOKit/Documentation.docc/MachOKit.md

@@ -1,3 +1,6 @@
 # ``MachOKit``
 
 🔬 A Swift library for parsing MachO files to obtain various information.
+
+> Note:
+> Unix archive (.a) format is supported by ``MachOArchiveKit``.

MachOKit.docc/MachOKitC.md …MachOKit/Documentation.docc/MachOKitC.mdMachOKit.docc/MachOKitC.md renamed to Sources/MachOKit/Documentation.docc/MachOKitC.md MachOKit.docc/MachOKitC.md renamed to Sources/MachOKit/Documentation.docc/MachOKitC.md

@@ -3,12 +3,14 @@
 //  MachOKit
 //
 //  Created by p-x9 on 2025/02/01
-//  
+//
 //
 
 #ifndef core_foundation_h
 #define core_foundation_h
 
+#include <stdint.h>
+
 // ref: https://github.com/apple-oss-distributions/CF/blob/dc54c6bb1c1e5e0b9486c1d26dd5bef110b20bf3/CFRuntime.h#L222-L228
 typedef struct __CFRuntimeBase64 {
     uint64_t _cfisa;

Sources/MachOKitC/include/core_foundation.h

@@ -6,7 +6,7 @@ preview_docc() {
   mkdir -p docs
 
   $(xcrun --find docc) preview \
-    "./${TARGET}.docc" \
+    "./Sources/${TARGET}/Documentation.docc" \
     --additional-symbol-graph-dir symbol-graphs \
     --output-path "docs"
 }

scripts/docc-preview.sh

@@ -7,7 +7,7 @@ generate_docc() {
   mkdir -p docs
 
   $(xcrun --find docc) convert \
-    "./${TARGET}.docc" \
+    "./Sources/${TARGET}/Documentation.docc" \
      --output-path "docs" \
      --hosting-base-path "${REPO_NAME}" \
      --additional-symbol-graph-dir ./symbol-graphs

scripts/docc.sh

@@ -28,10 +28,18 @@ generate_symbol_graphs() {
 
   xcodebuild clean build -scheme "${scheme}"\
     -destination "generic/platform=${destination}" \
-    OTHER_SWIFT_FLAGS="-emit-extension-block-symbols -emit-symbol-graph -emit-symbol-graph-dir $(pwd)/.build/symbol-graphs"
+    OTHER_SWIFT_FLAGS="-emit-extension-block-symbols -emit-symbol-graph -emit-symbol-graph-dir $(pwd)/.build/symbol-graphs" \
+    DOCC_EXTRACT_EXTENSION_SYMBOLS=YES
 
   mv "./.build/symbol-graphs/${scheme}.symbols.json" "${SYMBOL_DIR}/${scheme}_${destination}.symbols.json"
 
+  # Extension
+  for file in ./.build/symbol-graphs/${scheme}@*.symbols.json; do
+    if [ -f "$file" ]; then
+      mv "$file" "${SYMBOL_DIR}/$(basename "${file%.symbols.json}").symbols.json"
+    fi
+  done
+
   if [ -d "./Sources/$scheme/include" ]; then
     local HEADERS=$(ls "./Sources/$scheme/include")
     while IFS= read -r header; do
@@ -48,8 +56,10 @@ generate_symbol_graphs() {
 clean_build
 clean_xcbuild ios MachOKitC
 clean_xcbuild ios MachOKit
+clean_xcbuild ios MachOArchiveKit
 
 clean_symbol
 
 generate_symbol_graphs ios MachOKitC
 generate_symbol_graphs ios MachOKit
+generate_symbol_graphs ios MachOArchiveKit