How do I regenerate the XML documentation for a class if I change the scripting API from the source code?

0 votes

I've made changes to the _bind_methods function for a class and I want to update the documentation for the class as part of the PR I intend to submit. How do I go about updating the XML files with new generated content that includes my changes so that I can add the new descriptions accordingly?

in Engine by (186 points)

1 Answer

0 votes
Best answer

You can run godot --doctool <path> to dump the generated XML files. Running just godot --doctool . will put them where they are supposed to be in the main /godot/ folder and will merge them in with the existing XML docs. In this scenario, godot is the name of the path and name to your godot executable, for example ./bin/godot.x11.tools.64 would be a path from the godot directory root.

Note that this will regenerate the entire XML documentation. There is currently no way to individually update an XML file. This is because the scripting API used to all be in one XML file and was only separated into individual files during the 3.0 release. The command line interface has not been updated to reflect that change, so there is no way (as of yet) to update only a single file.

by (186 points)
edited by
Welcome to Godot Engine Q&A, where you can ask questions and receive answers from other members of the community.

Please make sure to read Frequently asked questions and How to use this Q&A? before posting your first questions.
Social login is currently unavailable. If you've previously logged in with a Facebook or GitHub account, use the I forgot my password link in the login box to set a password for your account. If you still can't access your account, send an email to [email protected] with your username.