update: header file descriptions #4489

danil-pavlov · 2024-10-14T17:36:11Z

No description provided.

docs/topics/native/apple-framework.md

docs/images/native/xcode-ios-add-framework.png

daniCsorbaJB

Great improvement 🚀 - I left some notes, please let me know what you think! 👍

daniCsorbaJB · 2024-11-27T10:18:18Z

docs/topics/native/apple-framework.md

@@ -1,371 +1,346 @@
 [//]: # (title: Kotlin/Native as an Apple framework – tutorial)

 > The Objective-C libraries import is [Experimental](components-stability.md#stability-levels-explained).
-> All Kotlin declarations generated by the `cinterop` tool from Objective-C libraries
+> All Kotlin declarations generated by the cinterop tool from Objective-C libraries
 > should have the `@ExperimentalForeignApi` annotation.


Hmm 🤔 is there a reason why we are saying should here?
Could we rephrase it like:
"When generating Kotlin declarations from Objective-C libraries with the cinterop tool, add the @ExperimentalForeignApi annotation.

This a common note for several pages that was approved by the dev team and changing it is not a part of this PR.
The IDE makes a suggestion in this case, so you don't actually add this annotation manually

daniCsorbaJB · 2024-11-27T10:26:06Z

docs/topics/native/apple-framework.md

-There is also the [Kotlin/Native as a Dynamic Library](native-dynamic-libraries.md)
-tutorial for more information.
+Kotlin/Native provides bidirectional interoperability with Objective-C/Swift. You can both use Objective-C frameworks
+and libraries in Kotlin code, and Kotlin modules in Swift/Objective-C code. 


Suggested change

and libraries in Kotlin code, and Kotlin modules in Swift/Objective-C code.

and libraries in Kotlin code, and Kotlin modules in Objective-C/Swift code.

just to keep it consistent (Objective-C/Swift )

I changed everywhere to Swift/Objective-C to keep it consistent with the main interop page

daniCsorbaJB · 2024-11-28T12:52:40Z

docs/topics/native/apple-framework.md


-<tabs group="build-script">
-<tab title="Kotlin" group-key="kotlin">
+While it's possible to use the command line to create a Kotlin framework, either directly or by combining it with a


(Optional - Suggestion)
This sentence feels a bit long, could we break it into two?
You can create a Kotlin framework using the command line, either directly or with a script file, such as a .sh or .bat file. However, this approach....

daniCsorbaJB · 2024-11-28T13:02:09Z

docs/topics/native/apple-framework.md


-Use the following `build.gradle(.kts)` Gradle build file:
+* [Create a Kotlin library and compile it to a framework](#create-a-kotlin-library)


In this bullet point we use the "compile to a framework" but in the section below we use "produce/build a framework"
While I think all terms are correct I think produce/build is slightly more accurate as the compilation is only part of it if I understand correctly.

That's different. Here, we're talking about doing smth with a library, and not a separate action of building a framework
options like "produce/build library to a framework" just don't work

daniCsorbaJB · 2024-11-28T13:03:43Z

docs/topics/native/apple-framework.md

-<tab title="Kotlin" group-key="kotlin">
+While it's possible to use the command line to create a Kotlin framework, either directly or by combining it with a
+script file (such as `.sh` or `.bat` file), this approach doesn't scale well for big projects that have hundreds of files
+and libraries. Therefore, it's better to compile using a build system, as it helps to download and cache the Kotlin/Native


again as above - perhaps we could avoid referring to the compilation (unless we want to highlight it specifically)
Suggestion - does this retain the same meaning? :

"Therefore, using a build system simplifies the process by downloading and caching the Kotlin/Native compiler binaries and the libraries with transitive dependencies, as well as running the compiler and tests."

daniCsorbaJB · 2024-11-29T09:30:20Z

docs/topics/native/apple-framework.md

-easier to use with Swift. Convert the previous Objective-C example
-into Swift. As a result, you'll have the following code in `main.swift`:
+The framework you compiled has helper attributes to make it easier to use with Swift. Let's convert the previous
+Objective-C example into Swift.


if someone is only reading the swift part here - could we include a link to the Objective-C example?
e.g.:
the previous Objective-C example

daniCsorbaJB · 2024-11-29T09:33:01Z

docs/topics/native/apple-framework.md

+only one instance. The `Object.shared` syntax is used to access this single instance.
+
+Methods and property names are translated as is. Kotlin's `String` is turned into Swift's `String`. Swift
+hides `NSNumber*` boxing too. You can also pass a Swift closure to Kotlin and call a Kotlin lambda function from Swift. 


could we include some clarification why this is good? - like:
Swift hides NSNumber* boxing too, making it seamless to work with Kotlin number types.

We're not trying to sell this point, just describing the code above

daniCsorbaJB · 2024-11-29T09:33:43Z

docs/topics/native/apple-framework.md

+There are some small differences between the original Kotlin code and its Swift version. In Kotlin, any `object` has 
+only one instance. The `Object.shared` syntax is used to access this single instance.
+
+Methods and property names are translated as is. Kotlin's `String` is turned into Swift's `String`. Swift


As before is there a way to avoid saying method here if it relates to Kotlin? 🤔

daniCsorbaJB · 2024-11-29T09:34:41Z

docs/topics/native/apple-framework.md

+
+## Connect the framework to iOS project
+
+Now you can connect the generated framework to the iOS project as a dependency. There are multiple ways to set it up


Suggested change

Now you can connect the generated framework to the iOS project as a dependency. There are multiple ways to set it up

Now you can connect the generated framework to your iOS project as a dependency. There are multiple ways to set it up

does this work like this?

daniCsorbaJB · 2024-11-29T09:34:58Z

docs/topics/native/apple-framework.md

+
+You can find more information about type mapping in [Interoperability with Swift/Objective-C](native-objc-interop.md#mappings).
+
+## Connect the framework to iOS project


Suggested change

## Connect the framework to iOS project

## Connect the framework to your iOS project

does this work like this?

danil-pavlov marked this pull request as ready for review October 17, 2024 11:49

danil-pavlov requested a review from a team as a code owner October 17, 2024 11:49

danil-pavlov requested a review from SvyatoslavScherbina October 17, 2024 11:49

SvyatoslavScherbina reviewed Oct 18, 2024

View reviewed changes

SvyatoslavScherbina reviewed Oct 24, 2024

View reviewed changes

docs/topics/native/apple-framework.md Outdated Show resolved Hide resolved

docs/topics/native/apple-framework.md Outdated Show resolved Hide resolved

docs/topics/native/apple-framework.md Outdated Show resolved Hide resolved

danil-pavlov requested a review from SvyatoslavScherbina November 13, 2024 18:26

SvyatoslavScherbina approved these changes Nov 14, 2024

View reviewed changes

docs/images/native/xcode-ios-add-framework.png Outdated Show resolved Hide resolved

danil-pavlov requested a review from daniCsorbaJB November 25, 2024 17:02

danil-pavlov added 8 commits November 25, 2024 18:04

update: header file descriptions

4c353fa

update: minor fixes

72dbf62

update: new intro

d0ee2a1

fix: review suggestions

53003f8

fix: code issues

ec7fd8f

update: debug task

212f2b0

update: ios target and connection methods

2382026

chore: minor fix

157b4c0

danil-pavlov force-pushed the native-apple-framework branch from c212cf5 to 157b4c0 Compare November 25, 2024 17:04

daniCsorbaJB self-assigned this Nov 27, 2024

daniCsorbaJB reviewed Nov 29, 2024

View reviewed changes

fix: review suggestions

29658aa

danil-pavlov requested a review from daniCsorbaJB December 2, 2024 15:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update: header file descriptions #4489

update: header file descriptions #4489

danil-pavlov commented Oct 14, 2024

daniCsorbaJB left a comment

daniCsorbaJB Nov 27, 2024

danil-pavlov Dec 2, 2024

daniCsorbaJB Nov 27, 2024

daniCsorbaJB Nov 27, 2024

danil-pavlov Dec 2, 2024

daniCsorbaJB Nov 28, 2024

daniCsorbaJB Nov 28, 2024

danil-pavlov Dec 2, 2024 •

edited

Loading

daniCsorbaJB Nov 28, 2024

daniCsorbaJB Nov 29, 2024

daniCsorbaJB Nov 29, 2024

danil-pavlov Dec 2, 2024

daniCsorbaJB Nov 29, 2024

daniCsorbaJB Nov 29, 2024

daniCsorbaJB Nov 29, 2024

daniCsorbaJB Nov 29, 2024

daniCsorbaJB Nov 29, 2024

	and libraries in Kotlin code, and Kotlin modules in Swift/Objective-C code.
	and libraries in Kotlin code, and Kotlin modules in Objective-C/Swift code.


		Use the following `build.gradle(.kts)` Gradle build file:
		* [Create a Kotlin library and compile it to a framework](#create-a-kotlin-library)


		## Connect the framework to iOS project

		Now you can connect the generated framework to the iOS project as a dependency. There are multiple ways to set it up


		You can find more information about type mapping in [Interoperability with Swift/Objective-C](native-objc-interop.md#mappings).

		## Connect the framework to iOS project

	## Connect the framework to iOS project
	## Connect the framework to your iOS project

update: header file descriptions #4489

Are you sure you want to change the base?

update: header file descriptions #4489

Conversation

danil-pavlov commented Oct 14, 2024

daniCsorbaJB left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

danil-pavlov Dec 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

danil-pavlov Dec 2, 2024 •

edited

Loading