mirror of
https://github.com/bevyengine/bevy
synced 2024-12-28 05:53:07 +00:00
a658bfef19
# Objective Resolves #6197 Make it so that doc comments can be retrieved via reflection. ## Solution Adds the new `documentation` feature to `bevy_reflect` (disabled by default). When enabled, documentation can be found using `TypeInfo::doc` for reflected types: ```rust /// Some struct. /// /// # Example /// /// ```ignore /// let some_struct = SomeStruct; /// ``` #[derive(Reflect)] struct SomeStruct; let info = <SomeStruct as Typed>::type_info(); assert_eq!( Some(" Some struct.\n\n # Example\n\n ```ignore\n let some_struct = SomeStruct;\n ```"), info.docs() ); ``` ### Notes for Reviewers The bulk of the files simply added the same 16 lines of code (with slightly different documentation). Most of the real changes occur in the `bevy_reflect_derive` files as well as in the added tests. --- ## Changelog * Added `documentation` feature to `bevy_reflect` * Added `TypeInfo::docs` method (and similar methods for all info types)
26 lines
No EOL
666 B
TOML
26 lines
No EOL
666 B
TOML
[package]
|
|
name = "bevy_reflect_derive"
|
|
version = "0.9.0-dev"
|
|
edition = "2021"
|
|
description = "Derive implementations for bevy_reflect"
|
|
homepage = "https://bevyengine.org"
|
|
repository = "https://github.com/bevyengine/bevy"
|
|
license = "MIT OR Apache-2.0"
|
|
keywords = ["bevy"]
|
|
|
|
[lib]
|
|
proc-macro = true
|
|
|
|
[features]
|
|
default = []
|
|
# When enabled, allows documentation comments to be processed by the reflection macros
|
|
documentation = []
|
|
|
|
[dependencies]
|
|
bevy_macro_utils = { path = "../../bevy_macro_utils", version = "0.9.0-dev" }
|
|
|
|
syn = { version = "1.0", features = ["full"] }
|
|
proc-macro2 = "1.0"
|
|
quote = "1.0"
|
|
uuid = { version = "1.1", features = ["v4"] }
|
|
bit-set = "0.5.2" |