Mirrors/bevy

Fork 0

mirror of https://github.com/bevyengine/bevy synced 2025-01-08 19:29:04 +00:00

Commit graph

Author	SHA1	Message	Date
Yutao Yuan	aabc47f290	Make public macros more robust with $crate (#4655 ) # Objective We have some macros that are public but only used internally for now. They fail on user's code due to the use of crate names like `bevy_utils`, while the user only has `bevy::utils`. There are two affected macros. - `bevy_utils::define_label`: it may be useful in user's code for defining custom kinds of label traits (this is why I made this PR). - `bevy_asset::load_internal_asset`: not useful currently due to limitations of the debug asset server, but this may change in the future. ## Solution We can make them work by using `$crate` instead of names of their own crates, which can refer to the macro's defining crate regardless of the user's setup. Even though our objective is rather low-priority here, the solution adds no maintenance cost so it is still worthwhile.	2022-05-06 19:29:45 +00:00
Daniel Bearden	b673c51e20	Bevy app docs (#3539 ) # Objective Achieve 100% documentation coverage for bevy_app crate. See #3492 ## Solution - Add #![warn(missing_docs)] to crate root - Add doc comments to public items - Add doc comment to bevy_utils::define_label macro trait	2022-01-06 23:16:47 +00:00
Zicklag	e290a7e29c	Implement Sub-App Labels (#2695 ) This is a rather simple but wide change, and it involves adding a new `bevy_app_macros` crate. Let me know if there is a better way to do any of this! --- # Objective - Allow adding and accessing sub-apps by using a label instead of an index ## Solution - Migrate the bevy label implementation and derive code to the `bevy_utils` and `bevy_macro_utils` crates and then add a new `SubAppLabel` trait to the `bevy_app` crate that is used when adding or getting a sub-app from an app.	2021-08-24 00:31:21 +00:00

Author

SHA1

Message

Date

Yutao Yuan

aabc47f290

Make public macros more robust with $crate (#4655 )

# Objective

We have some macros that are public but only used internally for now. They fail on user's code due to the use of crate names like `bevy_utils`, while the user only has `bevy::utils`. There are two affected macros.

- `bevy_utils::define_label`: it may be useful in user's code for defining custom kinds of label traits (this is why I made this PR).
- `bevy_asset::load_internal_asset`: not useful currently due to limitations of the debug asset server, but this may change in the future.

## Solution

We can make them work by using `$crate` instead of names of their own crates, which can refer to the macro's defining crate regardless of the user's setup. Even though our objective is rather low-priority here, the solution adds no maintenance cost so it is still worthwhile.

2022-05-06 19:29:45 +00:00

Daniel Bearden

b673c51e20

Bevy app docs (#3539 )

# Objective

Achieve 100% documentation coverage for bevy_app crate.
See #3492 

## Solution

- Add #![warn(missing_docs)] to crate root
- Add doc comments to public items
- Add doc comment to bevy_utils::define_label macro trait

2022-01-06 23:16:47 +00:00

Zicklag

e290a7e29c

Implement Sub-App Labels (#2695 )

This is a rather simple but wide change, and it involves adding a new `bevy_app_macros` crate. Let me know if there is a better way to do any of this!

---

# Objective

- Allow adding and accessing sub-apps by using a label instead of an index

## Solution

- Migrate the bevy label implementation and derive code to the `bevy_utils` and `bevy_macro_utils` crates and then add a new `SubAppLabel` trait to the `bevy_app` crate that is used when adding or getting a sub-app from an app.

2021-08-24 00:31:21 +00:00

3 commits