Add support for documenting most editor settings in the class reference

[Calinou]

Settings defined in editor plugins are missing (about 100 of them), but all other settings (about 200 of them) are now documented in the EditorSettings class.

This PR can be remade for the 3.x branch once we reach an agreement on its design.

This closes godotengine/godot-proposals#1339 and closes godotengine/godot-docs#395. See also #49524 and #49525 (can be merged independently).

Edit: This PR no longer includes the actual documentation for easier reviewing. Settings were actually documented in #63870.

TODO

• Write descriptions for all editor settings currently present in the XML.
  • Will be split to a second PR.
• Fix segfault at the end of --doctool . run (the XML is still generated fine).

In a future PR, I'll move editor setting default declarations to be located as much as possible in editor/editor_settings.cpp, so they can all be picked up by doctool and then documented.

[EricEzaM]

Settings which are defined inside editor constructors (e.g. EditorNode EDITOR_DEF("run/output/always_clear_output_on_play", true);) will not be picked up on since the editor is not instantiated. This is also true for some project settings which do not get picked up by the doctool, e.g. editor/main_run_args, see my comment here: godotengine/godot-proposals#1339 (comment)

[Calinou]

All settings present in the XML are now documented! That said, this doesn't mean all editor settings are now documented. Doing so would require significant refactoring to move editor setting declarations to a centralized location, so I'd prefer leaving this to a future PR.

Unfortunately, I didn't mange to fix the segfault issue when running --doctool. Could anyone lend me a hand on this?

Edit: Fixed by destroying the EditorSettings instance after using it. Thanks to @pycbouh for the advice 🙂

gdb backtrace

(gdb) bt
#0  OS::print_error (this=0x0, p_function=0x1c98122 "unref", 
    p_file=0x1d45cdd "core/string/string_name.cpp", p_line=94, p_code=0x1d5a38a "BUG!", 
    p_rationale=0x1e0f53e "", p_type=Logger::ERR_ERROR) at core/os/os.cpp:109
#1  0x0000000008f16395 in _err_print_error (p_function=0x1c98122 "unref", 
    p_file=0x1d45cdd "core/string/string_name.cpp", p_line=94, p_error=0x1d5a38a "BUG!", 
    p_message=0x1e0f53e "", p_type=ERR_HANDLER_ERROR) at core/error/error_macros.cpp:77
#2  0x0000000008f1634a in _err_print_error (p_function=0x1c98122 "unref", 
    p_file=0x1d45cdd "core/string/string_name.cpp", p_line=94, p_error=0x1d5a38a "BUG!", 
    p_type=ERR_HANDLER_ERROR) at core/error/error_macros.cpp:69
#3  0x0000000008eca5f3 in StringName::unref (this=0xbd2d5a0) at core/string/string_name.cpp:94
#4  0x0000000008ecf1a5 in StringName::~StringName (this=0xbd2d5a0) at core/string/string_name.cpp:378
#5  0x000000000668920e in EditorSettings::~EditorSettings (this=0xbd2d420)
    at editor/editor_settings.cpp:1746
#6  0x0000000006598b2f in memdelete<EditorSettings> (p_class=0xbd2d420) at ./core/os/memory.h:115
#7  0x0000000006598ae3 in Ref<EditorSettings>::unref (this=0x99ba7e8 <EditorSettings::singleton>)
    at ./core/object/reference.h:221
#8  0x0000000006598a85 in Ref<EditorSettings>::~Ref (this=0x99ba7e8 <EditorSettings::singleton>)
    at ./core/object/reference.h:233
#9  0x00007ffff7a78af7 in __run_exit_handlers () from /lib64/libc.so.6
#10 0x00007ffff7a78ca0 in exit () from /lib64/libc.so.6
#11 0x00007ffff7a60b7c in __libc_start_main () from /lib64/libc.so.6
#12 0x000000000486194e in _start ()

[connorshea]

This'd be great to have, I looked around for an issue/PR for this after trying to mess with some settings and not understanding what they do. Is there anything blocking this atm?

[Calinou]

This'd be great to have, I looked around for an issue/PR for this after trying to mess with some settings and not understanding what they do. Is there anything blocking this atm?

This needs to be tested again once #50864 is merged, to see whether documentation generation still works in that case (it probably does).

[akien-mga]

Needs a rebase.

If some extensive review is needed from @godotengine/documentation for the added descriptions, I would suggest splitting this in two PRs: one to add the possibility to generate and use editor settings docstrings, and sync the empty templates. And one that fills the templates.

[Calinou]

Rebased, with descriptions added for new settings.

I'm getting this error on CI, but I forgot where you force "fake" default values for doctool to use:

-		<member name="filesystem/directories/default_project_path" type="String" setter="" getter="" default="&quot;/home/hugo&quot;">
+		<member name="filesystem/directories/default_project_path" type="String" setter="" getter="" default="&quot;/home/runner&quot;">

[YuriSizov]

I'm getting this error on CI, but I forgot where you force "fake" default values for doctool to use:

I suspect we only have something for project settings, but not editor settings. The *_NOVAL_* macros, that is.

[akien-mga]

I pushed an update which makes the solution a lot less hacky. I think it's good to go now :)

[akien-mga]

Thanks!

[akien-mga]

Cherry-picked for 3.6.