Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion Sources/SwiftJavaToolLib/JavaClassTranslator.swift
Original file line number Diff line number Diff line change
Expand Up @@ -695,6 +695,20 @@ extension JavaClassTranslator {
let swiftMethodName = javaMethod.getName().escapedSwiftName
let swiftOptionalMethodName = "\(javaMethod.getName())Optional".escapedSwiftName

// --- Handle docs for the generated method.
// Include the original Java signature
let docsString =
"""
/**
* Java method `\(javaMethod.getName())`.
*
* ### Java method signature
* ```java
* \(javaMethod.toGenericString())
* ```
*/
"""

// Compute the parameters for '@...JavaMethod(...)'
let methodAttribute: AttributeSyntax
if implementedInSwift {
Expand Down Expand Up @@ -755,9 +769,9 @@ extension JavaClassTranslator {
baseBody
}


return
"""
\(raw: docsString)
\(methodAttribute)\(raw: accessModifier)\(raw: overrideOpt)func \(raw: swiftMethodName)\(raw: genericParameterClauseStr)(\(raw: parametersStr))\(raw: throwsStr)\(raw: resultTypeStr)\(raw: whereClause)

\(raw: accessModifier)\(raw: overrideOpt)func \(raw: swiftOptionalMethodName)\(raw: genericParameterClauseStr)(\(raw: parameters.map(\.clause.description).joined(separator: ", ")))\(raw: throwsStr) -> \(raw: resultOptional)\(raw: whereClause) {
Expand All @@ -767,6 +781,7 @@ extension JavaClassTranslator {
} else {
return
"""
\(raw: docsString)
\(methodAttribute)\(raw: accessModifier)\(raw: overrideOpt)func \(raw: swiftMethodName)\(raw: genericParameterClauseStr)(\(raw: parametersStr))\(raw: throwsStr)\(raw: resultTypeStr)\(raw: whereClause)
"""
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,42 @@ final class BasicWrapJavaTests: XCTestCase {
)
}

func testWrapJava_docs_signature() async throws {
let classpathURL = try await compileJava(
"""
package com.example;

class ExampleSimpleClass {
public void example(String name, int age) { }
}
""")

try assertWrapJavaOutput(
javaClassNames: [
"com.example.ExampleSimpleClass"
],
classpath: [classpathURL],
expectedChunks: [
"""
import CSwiftJavaJNI
import SwiftJava
""",
"""
/**
* Java method `example`.
*
* ### Java method signature
* ```java
* public void com.example.ExampleSimpleClass.example(java.lang.String,int)
* ```
*/
@JavaMethod
open func example(_ arg0: String, _ arg1: Int32)
"""
]
)
}

func test_wrapJava_doNotDupeImportNestedClassesFromSuperclassAutomatically() async throws {
let classpathURL = try await compileJava(
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -257,10 +257,6 @@ final class GenericsWrapJavaTests: XCTestCase {
@JavaClass("com.example.ByteArray")
open class ByteArray: JavaObject {
""",
// """
// @JavaInterface("com.example.Store")
// public struct Store<K: AnyJavaObject, V: AnyJavaObject, T: AnyJavaObject> {
// """,
"""
@JavaClass("com.example.CompressingStore")
open class CompressingStore: AbstractStore<ByteArray, [UInt8], [UInt8]> {
Expand Down Expand Up @@ -292,6 +288,8 @@ final class GenericsWrapJavaTests: XCTestCase {
"""
@JavaClass("com.example.Kappa")
open class Kappa<T: AnyJavaObject>: JavaObject {
""",
"""
@JavaMethod(typeErasedResult: "T!")
open func get() -> T!
}
Expand Down
Loading