From 0d2c9830112b5d9dc9e6301637d7e186e6d536f6 Mon Sep 17 00:00:00 2001 From: Max Desiatov Date: Mon, 14 Sep 2020 22:04:31 +0100 Subject: [PATCH 1/5] Generate and publish documentation with `swift-doc` --- .github/workflows/documentation.yml | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .github/workflows/documentation.yml diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 000000000..9a81d4951 --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,24 @@ +name: Documentation + +on: [push] + +jobs: + swift-doc: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v1 + - name: Generate Documentation + uses: MaxDesiatov/swift-doc@prebuilt-image + with: + inputs: "Sources" + module-name: JavaScriptKit + format: html + base-url: "/JavaScriptKit" + output: ./.build/documentation + - run: sudo chmod o+r -R ./.build/documentation + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./.build/documentation From f98bb11a6c9c5d479ad12d4fc64a070037eab42f Mon Sep 17 00:00:00 2001 From: Max Desiatov Date: Tue, 15 Sep 2020 10:14:04 +0100 Subject: [PATCH 2/5] Make `@_cdecl` functions internal --- Sources/JavaScriptKit/FundamentalObjects/JSFunction.swift | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Sources/JavaScriptKit/FundamentalObjects/JSFunction.swift b/Sources/JavaScriptKit/FundamentalObjects/JSFunction.swift index 8379b175f..92a52d0be 100644 --- a/Sources/JavaScriptKit/FundamentalObjects/JSFunction.swift +++ b/Sources/JavaScriptKit/FundamentalObjects/JSFunction.swift @@ -105,18 +105,18 @@ public class JSClosure: JSFunction { } @_cdecl("swjs_prepare_host_function_call") -public func _prepare_host_function_call(_ argc: Int32) -> UnsafeMutableRawPointer { +func _prepare_host_function_call(_ argc: Int32) -> UnsafeMutableRawPointer { let argumentSize = MemoryLayout.size * Int(argc) return malloc(Int(argumentSize))! } @_cdecl("swjs_cleanup_host_function_call") -public func _cleanup_host_function_call(_ pointer: UnsafeMutableRawPointer) { +func _cleanup_host_function_call(_ pointer: UnsafeMutableRawPointer) { free(pointer) } @_cdecl("swjs_call_host_function") -public func _call_host_function( +func _call_host_function( _ hostFuncRef: JavaScriptHostFuncRef, _ argv: UnsafePointer, _ argc: Int32, _ callbackFuncRef: JavaScriptObjectRef From 2af259d8a1e6a2c03f80180a7e4791a637cee9ec Mon Sep 17 00:00:00 2001 From: Max Desiatov Date: Tue, 15 Sep 2020 10:14:53 +0100 Subject: [PATCH 3/5] Fix `JSDate` doc comment wording --- Sources/JavaScriptKit/BasicObjects/JSError.swift | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Sources/JavaScriptKit/BasicObjects/JSError.swift b/Sources/JavaScriptKit/BasicObjects/JSError.swift index be1760772..138bb1637 100644 --- a/Sources/JavaScriptKit/BasicObjects/JSError.swift +++ b/Sources/JavaScriptKit/BasicObjects/JSError.swift @@ -1,4 +1,4 @@ -/** A wrapper around the [JavaScript Error +/** A wrapper around [the JavaScript Error class](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) that exposes its properties in a type-safe way. */ From 8c348a3efe6c61b5506926ee67153a3ea0990355 Mon Sep 17 00:00:00 2001 From: Max Desiatov Date: Tue, 15 Sep 2020 10:15:49 +0100 Subject: [PATCH 4/5] Fix `JSError.stack` doc comment wording --- Sources/JavaScriptKit/BasicObjects/JSError.swift | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Sources/JavaScriptKit/BasicObjects/JSError.swift b/Sources/JavaScriptKit/BasicObjects/JSError.swift index 138bb1637..fe779cc61 100644 --- a/Sources/JavaScriptKit/BasicObjects/JSError.swift +++ b/Sources/JavaScriptKit/BasicObjects/JSError.swift @@ -24,7 +24,7 @@ public final class JSError: Error { jsObject.name.string! } - /// The JavaScript call trace that led to the creation of this error object. + /// The JavaScript call stack that led to the creation of this error object. public var stack: String? { jsObject.stack.string } From 3160ab45af1ee093e9bb7e2f9941bc3b62d305f4 Mon Sep 17 00:00:00 2001 From: Max Desiatov Date: Tue, 15 Sep 2020 10:19:04 +0100 Subject: [PATCH 5/5] Deploy docs only on push to `master` --- .github/workflows/documentation.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 9a81d4951..3567e20c3 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -1,6 +1,8 @@ name: Documentation -on: [push] +on: + push: + branches: [master] jobs: swift-doc: