FyroxEngine / Fyrox

3D and 2D game engine written in Rust
https://fyrox.rs
MIT License
7.48k stars 339 forks source link

Expanding documentation for inspector module and adding ImmutableString editor. #631

Closed b-guild closed 2 months ago

b-guild commented 2 months ago

In my project to create an editor for ImmutableString, I needed to learn to understand the inspector module. To help with this, I added documentation to many undocumented elements of that module. These comments were written by someone who was struggling to understand the design of the inspector module, and so hopefully they can be helpful to other people who might struggle to understand.

This also means that there may be mistakes in the documentation. I would be eager to see those mistakes corrected or the documentation expanded even further, so that I can see what I failed to understand from studying the module.