Contribuer à la référence des classes

The class reference is available online in the classes section of the documentation and in the Godot editor, from the help menu.

In the class reference, some methods, variables, and signals lack descriptions. Others changed with recent releases and need updates. The developers can't write the entire reference on their own. Godot needs you, and all of us, to contribute.

Important: If you plan to make large changes, you should create an issue on the godot-docs repository or comment on an existing issue. Doing so lets others know you're already taking care of a given class.

Voir aussi

You can find the writing guidelines for the class reference here.

For details on Git usage and the pull request workflow, please refer to the Flux de travail pour les Pull Request page.

If you want to translate the class reference from English to another language, see Localisation de l'éditeur et de la documentation.

This guide is also available as a video tutorial on YouTube.

Voir aussi

Not sure which class to contribute to? Take a look at the class reference's completion status here.

You can find the source files for the class reference in Godot's GitHub repository: doc/classes/.

Note

For some modules in the engine's source code, you'll find the XML files in the modules/<module_name>/doc_classes/ directory instead.

Avertissement

Always edit the API reference through these source XML files. Do not edit the generated .rst files in the online documentation, hosted in the godot-docs repository.

Avertissement

Unless you make minor changes, like fixing a typo, we do not recommend using the GitHub web editor to edit the class reference's XML.

It lacks features to edit XML well, like keeping indentations consistent, and it does not allow amending commits based on reviews.

Also, it doesn't allow you to test your changes in the engine or with validation scripts as described in Comment modifier la classe XML.

Mise à jour du modèle de documentation

When you create a new class or modify the engine's API, you need to re-generate the XML files in doc/classes/.

To do so, you first need to compile Godot. See the Introduction au buildsystem page to learn how. Then, execute the compiled Godot binary from the Godot root directory with the --doctool option. For example, if you're on 64-bit Linux, the command is:

./bin/godot.linuxbsd.tools.64 --doctool

Les fichiers XML dans doc/classes devraient alors être à jour avec les fonctionnalités actuelles de Godot Engine. Vous pouvez ensuite vérifier ce qui a changé en utilisant la commande "git diff". Veuillez n'inclure dans vos commits que les changements qui sont pertinents pour votre travail sur l'API. Vous pouvez supprimer les changements dans d'autres fichiers XML en utilisant la commande git checkout.