Up to date

This page is up to date for Godot 4.3. If you still find outdated information, please open an issue.

Contribuer à la référence des classes

The Class reference is a set of articles describing the public API of the engine. This includes descriptions for various classes, methods, properties, and global objects, available for scripting. The class reference is available online, from the documentation sidebar, and in the Godot editor, from the help menu.

As the engine grows and features are added or modified, some parts of the class reference become obsolete and new descriptions and examples need to be added. While developers are encouraged to document all of their work in the class reference when submitting a pull request, we can't expect everyone to be able to write high quality documentation, so there is always work for contributors like you to polish existing and create missing reference material.

The source of the class reference

As the class reference is available in two places, online and in the editor, we need to take care to keep things in sync. To achieve this the main Godot repository is picked as the source of truth, and the documentation for the class reference is tracked there.

Avertissement

You should not edit .rst files in the classes/ folder of the documentation repository. These files are generated automatically and are synced manually by project maintainers. Read further to learn how to correctly edit the class reference.

In the main repository the class reference is stored in XML files, one for each exposed class or global object. The majority of these files is located in doc/classes/, but some modules contain their own documentation as well. You will find it in the modules/<module_name>/doc_classes/ directory. To learn more about editing XML files refer to Class reference primer.

Voir aussi

Pour plus de détails sur l'utilisation de Git et le flux de travail pull request, veuillez consulter la page Flux de travail pour les Pull Request.

Si vous souhaitez traduire la référence de la classe de l'anglais vers une autre langue, consultez Localisation de l'éditeur et de la documentation. Ce guide est aussi disponible en tant que tutoriel vidéo sur YouTube.

Important : Si vous prévoyez d'apporter des modifications importantes, vous devriez créer une issue sur le dépôt godot-docs ou commenter une issue existante. En faisant cela, les autres savent que vous occupez déjà d'une classe donnée.

Que contribuer

The natural place to start contributing is the classes that you are most familiar with. This ensures that the added description will be based on experience and the necessary know-how, not just the name of a method or a property. We advise not to add low effort descriptions, no matter how appealing it may look. Such descriptions obscure the need for documentation and are hard to identify automatically.

Voir aussi

Following this principle is important and allows us to create tools for contributors. Such as the class reference's completion status tracker. You can use it to quickly find documentation pages missing descriptions.

Si vous décidez de documenter une classe, mais ne savez pas ce qu'une méthode particulière fait, aucun problème. Laissez-la pour le moment et listez les méthodes que vous avez passé quand vous faites un pull request de vos changements. Un autre contributeur s'en occupera.

Vous pouvez toujours regarder l'implémentation des méthodes dans le code source de Godot sur GitHub. Ainsi, si vous avez des doutes, n'hésitez pas à poser des questions sur le site web Q&R et sur le Chat des Contributors de Godot.

Avertissement

À moins que vous n'apportiez des modifications mineures, comme la correction d'une coquille, nous ne recommandons pas d'utiliser l'éditeur web de GitHub pour modifier le XML de la référence de classe. Il manque des fonctionnalités pour bien modifier du XML, comme maintenir les indentations de manière consistantes, et il ne permet pas de modifier les commits basés sur les examens.

De plus, il ne vous permet pas de tester vos modifications dans le moteur ou avec des scripts de validation comme décrit dans Comment modifier la classe XML.

Updating class reference when working on the engine

Lorsque vous créez une nouvelle classe ou modifiez l'API du moteur, vous devez générer à nouveau les fichiers XML dans doc/classes/.

Pour ce faire, vous devez d'abord compiler Godot. Consultez la page Introduction au buildsystem pour savoir comment faire. Ensuite, exécutez le binaire Godot compilé depuis le répertoire racine de Godot avec l'option --doctool. Par exemple, si vous êtes sous Linux 64 bits, la commande peut être :

./bin/godot.linuxbsd.editor.x86_64 --doctool

L'ensemble exact de suffixes peut être différent. Lisez attentivement l'article lié pour en savoir plus.

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.

Please only include changes that are relevant to your work on the API in your commits. You can discard changes in other XML files using git checkout, but consider reporting if you notice unrelated files being updated. Ideally, running this command should only bring up the changes that you yourself have made.

Vous devrez ensuite ajouter des descriptions à toutes les entrées nouvellement générées.