Document editor import options in the class reference

[Calinou]

Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings).

This closes godotengine/godot-proposals#2041. See also #48548 and #49525 (can be merged independently).

Preview

Disregard the black text – it's not a bug related to this PR.

Import dock

Import defaults editor

TODO

• Only one importer is present in the documentation right now. Add the rest of the importers.
• Write documentation for all importers.

[reduz]

This would be good to salvage, but it likely got a bit more complicated with the new importer.

[akien-mga]

I think this can be improved by properly overriding _get_property_list so no hacks are needed, I'll test.

[akien-mga]

Updated to improve the hack and make it work for all ResourceImporter-derived classes.

The old docs for ResourceImporterTexture are not included, they should be salvaged from https://github.com/godotengine/godot/blob/6694a9eba9b9b63436e44594b844101c56f7c74f/doc/classes/ResourceImporterTexture.xml for a follow-up PR (like for editor settings, I prefer we focus first on how to make those available for documentation, and the actual doc writing and proofreading should be done separately).

[akien-mga]

Would be good to check if this should be renamed or hidden.

[akien-mga]

Default values don't seem to be included properly, yet they're seen as "valid" so it shows default="null" for all (unlike e.g. EditorSettings where it doesn't show default).

[akien-mga]

I pushed a second commit that solves this by calling get_import_options directly from DocTools so we can have access to the default value in ImportOption. It's a bit more hacky though. 09f0f70d81f50f7740268bcba4aff2106a9ec8cd

The less hacky option would be to properly register import options as properties in ClassDB with their default values, and then we don't need any of these hacks.

[YuriSizov]

This would be nice to have, but seems to be in need of extra work. I'm kicking it to 4.x, but hoping that we can merge it in 4.0.

[Calinou]

Rebased and tested again, it works as expected. Descriptions still need to be filled out, but the editor display works correctly.

Note that Advanced Import Settings options don't have a XML generated for yet. This should be tackled in a separate PR, as it's likely quite complex to get right.

[akien-mga]

Looks good to me. We can merge after 4.1 is released and document all this for 4.2.

It's still a draft, anything major still pending?

[Calinou]

It's still a draft, anything major still pending?

No, I forgot to mark it as ready for review. I just did that 🙂

[YuriSizov]

Should we change the title and the commit message to something different? Objectively, this doesn't actually document much, but it allows for these options to be documented. We don't want to have misleading information in changelogs :)

[YuriSizov]

Uhm, I think I got distracted and merged it anyway :D Welp, no matter now. Thanks!

[Calinou]

Uhm, I think I got distracted and merged it anyway :D Welp, no matter now. Thanks!

I'm starting work on documenting all import options – it shouldn't take too long before I open a PR with filled descriptions.

Edit: Done: #79405