Skip to content

Commit c6ddcee

Browse files
authored
Update uniffi-bindgen docstrings, fixes #1841 (#1843)
1 parent 7cd3aac commit c6ddcee

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

uniffi_bindgen/src/lib.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,8 @@
5858
//!
5959
//! ### 3) Generate and include component scaffolding from the UDL file
6060
//!
61-
//! First you will need to install `uniffi-bindgen` on your system using `cargo install uniffi_bindgen`.
62-
//! Then add to your crate `uniffi_build` under `[build-dependencies]`.
63-
//! Finally, add a `build.rs` script to your crate and have it call `uniffi_build::generate_scaffolding`
61+
//! Add to your crate `uniffi_build` under `[build-dependencies]`,
62+
//! then add a `build.rs` script to your crate and have it call `uniffi_build::generate_scaffolding`
6463
//! to process your `.udl` file. This will generate some Rust code to be included in the top-level source
6564
//! code of your crate. If your UDL file is named `example.udl`, then your build script would call:
6665
//!
@@ -77,12 +76,13 @@
7776
//!
7877
//! ### 4) Generate foreign language bindings for the library
7978
//!
80-
//! The `uniffi-bindgen` utility provides a command-line tool that can produce code to
79+
//! You will need ensure a local `uniffi-bindgen` - see <https://mozilla.github.io/uniffi-rs/tutorial/foreign_language_bindings.html>
80+
//! This utility provides a command-line tool that can produce code to
8181
//! consume the Rust library in any of several supported languages.
8282
//! It is done by calling (in kotlin for example):
8383
//!
8484
//! ```text
85-
//! uniffi-bindgen --language kotlin ./src/example.udl
85+
//! cargo run --bin -p uniffi-bindgen --language kotlin ./src/example.udl
8686
//! ```
8787
//!
8888
//! This will produce a file `example.kt` in the same directory as the .udl file, containing kotlin bindings

0 commit comments

Comments
 (0)