Improve docs re: proc macros #1848
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mhammond
reviewed
Nov 14, 2023
| All you need to do is add this to the top of `lib.rs`: | ||
|
|
||
| ```rust | ||
| uniffi::setup_scaffolding!(); |
There was a problem hiding this comment.
please add something like: The setup_scaffolding function takes one optional parameter, the ["namespace"](../udl/namespace,md] used by the component. If not specified, the name of the crate will be used as the namespace.
There was a problem hiding this comment.
Good call; that's super helpful.
|
|
||
| Use `generate --library` to generate foreign bindings by using a cdylib file built for your library. | ||
| This flag was added in UniFFI 0.24 and can be more convenient than specifying the UDL file -- especially when multiple UniFFI-ed crates are built together in one library. | ||
| The plan is to make library mode the default in a future UniFFI version. | ||
| The plan is to make library mode the default in a future UniFFI version, and it is highly recommended to specify the flag for now. |
There was a problem hiding this comment.
maybe add here "because some features simply don't work otherwise"?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1816.