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) |
||
|---|---|---|
| .. | ||
| impls | ||
| container_attributes.rs | ||
| derive_data.rs | ||
| documentation.rs | ||
| enum_utility.rs | ||
| field_attributes.rs | ||
| from_reflect.rs | ||
| lib.rs | ||
| reflect_value.rs | ||
| registration.rs | ||
| trait_reflection.rs | ||
| type_uuid.rs | ||
| utility.rs | ||