Replace DocC with Doxygen

btfuse · Oct 6, 2024 · 7e50e66 · 7e50e66
1 parent 0feb9b8
commit 7e50e66
Show file tree

Hide file tree

Showing 18 changed files with 2,988 additions and 128 deletions.
diff --git a/docs/build.sh b/docs/build.sh
@@ -27,22 +27,24 @@ spushd ../android
 spopd
 
 echo "Building Fuse iOS Reference Documentation..."
-spushd ../ios
-    xcodebuild -quiet -workspace BTFuse.xcworkspace -scheme BTFuse -configuration Release -destination 'generic/platform=iOS' docbuild
-    xcodebuild -quiet -workspace BTFuse.xcworkspace -scheme BTFuseTestTools -configuration Release -destination 'generic/platform=iOS' docbuild
+doxygen ../ios/Doxyfile
+# spushd ../ios
+#     xcodebuild -quiet -workspace BTFuse.xcworkspace -scheme BTFuse -configuration Release -destination 'generic/platform=iOS' docbuild
+#     xcodebuild -quiet -workspace BTFuse.xcworkspace -scheme BTFuseTestTools -configuration Release -destination 'generic/platform=iOS' docbuild
 
-    iosBuild=$(echo "$(xcodebuild -workspace BTFuse.xcworkspace -scheme BTFuse -configuration Release -sdk iphoneos -showBuildSettings | grep -E '^\s*CONFIGURATION_BUILD_DIR =' | awk -F '= ' '{print $2}' | xargs)")
-    simBuild=$(echo "$(xcodebuild -workspace BTFuse.xcworkspace -scheme BTFuse -configuration Debug -sdk iphonesimulator -showBuildSettings | grep -E '^\s*CONFIGURATION_BUILD_DIR =' | awk -F '= ' '{print $2}' | xargs)")
+#     iosBuild=$(echo "$(xcodebuild -workspace BTFuse.xcworkspace -scheme BTFuse -configuration Release -sdk iphoneos -showBuildSettings | grep -E '^\s*CONFIGURATION_BUILD_DIR =' | awk -F '= ' '{print $2}' | xargs)")
+#     simBuild=$(echo "$(xcodebuild -workspace BTFuse.xcworkspace -scheme BTFuse -configuration Debug -sdk iphonesimulator -showBuildSettings | grep -E '^\s*CONFIGURATION_BUILD_DIR =' | awk -F '= ' '{print $2}' | xargs)")
 
-    rm -rf ../docs/build
-    mkdir -p ../docs/build
+#     rm -rf ../docs/build
+#     mkdir -p ../docs/build
 
-    rm -rf ../docs/docs/ref/fuse-ios
-    mkdir -p ../docs/docs/ref/fuse-ios
+#     rm -rf ../docs/docs/ref/fuse-ios
+#     mkdir -p ../docs/docs/ref/fuse-ios
 
-    xcrun docc convert ./Overview.docc  --fallback-display-name BTFuse --output-dir ../docs/build/Overview.doccarchive
-    xcrun docc merge ../docs/build/Overview.doccarchive $iosBuild/BTFuse.doccarchive $iosBuild/BTFuseTestTools.doccarchive --output-path ../docs/docs/ref/fuse-ios
-spopd
+#     xcrun docc convert ./Overview.docc  --fallback-display-name BTFuse --output-dir ../docs/build/Overview.doccarchive
+#     xcrun docc merge ../docs/build/Overview.doccarchive $iosBuild/BTFuse.doccarchive $iosBuild/BTFuseTestTools.doccarchive --output-path ../docs/build/merged.doccarchive
+#     xcrun docc process-archive transform-for-static-hosting ../docs/build/merged.doccarchive --hosting-base-path ref/fuse-ios --output-path ../docs/docs/ref/fuse-ios/
+# spopd
 
 rm -rf ./docs/ref/fuse-android
 cp -r ../android/fuse/build/docs/javadoc ./docs/ref/fuse-android

diff --git a/docs/docs/api-ref/index.md b/docs/docs/api-ref/index.md
diff --git a/docs/docs/api-ref/js/core.md b/docs/docs/api-ref/js/core.md
diff --git a/docs/docs/api-ref/js/ref/ContentType.md b/docs/docs/api-ref/js/ref/ContentType.md
diff --git a/docs/docs/api-ref/js/ref/Platform.md b/docs/docs/api-ref/js/ref/Platform.md
diff --git a/docs/ios/header.html b/docs/ios/header.html
@@ -0,0 +1,5 @@
+<div id="titlearea"></div>
+    <h1>BTFuse</h1>
+    <!-- Add your custom link here -->
+    <a href="https://example.com/main-docs" style="position:absolute; right:10px; top:10px;">Main Documentation</a>
+</div>
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -81,9 +81,4 @@ nav:
   - API Reference:
     - Fuse JS: ref/fuse-js/index.html
     - Fuse Android: ref/fuse-android/index.html
-    - Fuse iOS: ref/fuse-ios/documentation/overview/index.html
-
-  # - API Reference:
-  #   - Index: api-ref/index.md
-  #   - Webview:
-  #     - Core: api-ref/js/core.md
+    # - Fuse iOS: ref/fuse-ios/index.html
diff --git a/ios/BTFuse.xcworkspace/contents.xcworkspacedata b/ios/BTFuse.xcworkspace/contents.xcworkspacedata
diff --git a/ios/BTFuse/BTFuse.docc/BTFuse.md b/ios/BTFuse/BTFuse.docc/BTFuse.md
diff --git a/ios/BTFuse/BTFuse.xcodeproj/project.pbxproj b/ios/BTFuse/BTFuse.xcodeproj/project.pbxproj
@@ -77,7 +77,6 @@
 		94B7A9D02AC89E39003D294D /* BTFuse.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 94A886C22A714F6D0098530D /* BTFuse.framework */; platformFilter = ios; };
 		94C3AF282B6867B8006AD040 /* LICENSE in Resources */ = {isa = PBXBuildFile; fileRef = 94C3AF272B6867B8006AD040 /* LICENSE */; };
 		94DF9FB72B293C9C00757EA7 /* UniformTypeIdentifiers.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 94DF9FB62B293C9C00757EA7 /* UniformTypeIdentifiers.framework */; };
-		94F13A1D2CA4EF1800CCCC89 /* BTFuse.docc in Sources */ = {isa = PBXBuildFile; fileRef = 94F13A1C2CA4EF1800CCCC89 /* BTFuse.docc */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXContainerItemProxy section */
@@ -165,7 +164,6 @@
 		94B7A9CE2AC89E39003D294D /* BTFuseTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = BTFuseTests.m; sourceTree = "<group>"; };
 		94C3AF272B6867B8006AD040 /* LICENSE */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; name = LICENSE; path = ../LICENSE; sourceTree = "<group>"; };
 		94DF9FB62B293C9C00757EA7 /* UniformTypeIdentifiers.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = UniformTypeIdentifiers.framework; path = System/Library/Frameworks/UniformTypeIdentifiers.framework; sourceTree = SDKROOT; };
-		94F13A1C2CA4EF1800CCCC89 /* BTFuse.docc */ = {isa = PBXFileReference; lastKnownFileType = folder.documentationcatalog; path = BTFuse.docc; sourceTree = "<group>"; };
 		C0D504787CFDCC13C7D8462D /* Pods-BTFuse.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-BTFuse.release.xcconfig"; path = "Target Support Files/Pods-BTFuse/Pods-BTFuse.release.xcconfig"; sourceTree = "<group>"; };
 		D2524D348AB6B72B049BC41D /* Pods-BTFuse.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-BTFuse.debug.xcconfig"; path = "Target Support Files/Pods-BTFuse/Pods-BTFuse.debug.xcconfig"; sourceTree = "<group>"; };
 /* End PBXFileReference section */
@@ -244,7 +242,6 @@
 		94A8864F2A702C6C0098530D = {
 			isa = PBXGroup;
 			children = (
-				94F13A1C2CA4EF1800CCCC89 /* BTFuse.docc */,
 				94C3AF272B6867B8006AD040 /* LICENSE */,
 				944112B92AED442300309527 /* PrivacyInfo.xcprivacy */,
 				94552C592ACB349A00DAE0F4 /* configurations */,
@@ -550,7 +547,6 @@
 				9443F0B12B1AA9550056B054 /* BTFuseNWErrorFactory.m in Sources */,
 				94A928532B13E4C700AAC44A /* BTFuseAPIServerHeaders.m in Sources */,
 				94A886BB2A714F6D0098530D /* BTFuseSchemeHandler.m in Sources */,
-				94F13A1D2CA4EF1800CCCC89 /* BTFuse.docc in Sources */,
 				9418629D2A9956F100CCFEE1 /* BTFuseAPIRouter.m in Sources */,
 				9489EB9A2AA54FED0087424D /* BTFuseRuntime.m in Sources */,
 				94A928572B1A729000AAC44A /* BTFuseIDGenerator.m in Sources */,

diff --git a/ios/BTFuse/BTFuseTestTools/BTFuseTestTools.docc/BTFuseTestTools.md b/ios/BTFuse/BTFuseTestTools/BTFuseTestTools.docc/BTFuseTestTools.md
diff --git a/ios/BTFuse/BTFuseTestTools/BTFuseTestTools.xcodeproj/project.pbxproj b/ios/BTFuse/BTFuseTestTools/BTFuseTestTools.xcodeproj/project.pbxproj
@@ -20,7 +20,6 @@
 		94C3AF2B2B68681A006AD040 /* LICENSE in Resources */ = {isa = PBXBuildFile; fileRef = 94C3AF2A2B68681A006AD040 /* LICENSE */; };
 		94D499BB2AC9CFEE009917A7 /* BTFuseTestAPIClient.h in Headers */ = {isa = PBXBuildFile; fileRef = 94D499BA2AC9CFEE009917A7 /* BTFuseTestAPIClient.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		94D499BD2AC9D254009917A7 /* BTFuseTestAPIClient.m in Sources */ = {isa = PBXBuildFile; fileRef = 94D499BC2AC9D254009917A7 /* BTFuseTestAPIClient.m */; };
-		94F13A1F2CA4EF2C00CCCC89 /* BTFuseTestTools.docc in Sources */ = {isa = PBXBuildFile; fileRef = 94F13A1E2CA4EF2C00CCCC89 /* BTFuseTestTools.docc */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXFileReference section */
@@ -39,7 +38,6 @@
 		94C3AF2A2B68681A006AD040 /* LICENSE */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; name = LICENSE; path = ../../LICENSE; sourceTree = "<group>"; };
 		94D499BA2AC9CFEE009917A7 /* BTFuseTestAPIClient.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = BTFuseTestAPIClient.h; sourceTree = "<group>"; };
 		94D499BC2AC9D254009917A7 /* BTFuseTestAPIClient.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = BTFuseTestAPIClient.m; sourceTree = "<group>"; };
-		94F13A1E2CA4EF2C00CCCC89 /* BTFuseTestTools.docc */ = {isa = PBXFileReference; lastKnownFileType = folder.documentationcatalog; path = BTFuseTestTools.docc; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -80,7 +78,6 @@
 		947FF0FB2AC8A82E003D09BC = {
 			isa = PBXGroup;
 			children = (
-				94F13A1E2CA4EF2C00CCCC89 /* BTFuseTestTools.docc */,
 				94C3AF2A2B68681A006AD040 /* LICENSE */,
 				944112BB2AED44C800309527 /* PrivacyInfo.xcprivacy */,
 				947FF1072AC8A82E003D09BC /* BTFuseTestTools */,
@@ -206,7 +203,6 @@
 				946278462AC8A987008A89FA /* BTFuseTestViewController.m in Sources */,
 				9462784E2AC8B1AF008A89FA /* BTFuseTestAPIResponse.m in Sources */,
 				946278522AC8B3EE008A89FA /* BTFuseTestAPIResponseFactory.m in Sources */,
-				94F13A1F2CA4EF2C00CCCC89 /* BTFuseTestTools.docc in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};