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.

Dans la référence de la classe, certaines méthodes, variables et signaux manquent de description. D'autres ont changé avec les dernières versions et nécessitent des mises à jour. Les développeurs ne peuvent pas écrire la référence entière par eux-mêmes. Godot a besoin de vous, et de nous tous, pour y contribuer.

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.

Voir aussi

Vous pouvez trouver les directives d'écriture pour la référence de classe ici.

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 également disponible sous forme de tutoriel vidéo sur YouTube.

Voir aussi

Vous n'êtes pas sûr de la classe à laquelle contribuer ? Jetez un œil à l'état d'achèvement de la référence de la classe ici.

Vous pouvez trouver les fichiers sources de la référence de la classe dans le dépôt GitHub de Godot : doc/classes/.

Note

Pour certains modules du code source du moteur, vous trouverez les fichiers XML dans le répertoire modules/<module_name>/doc_classes/ à la place.

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

À 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 lui manque des fonctionnalités pour bien éditer le XML, comme le maintien d'indentations cohérentes, et il ne permet pas de modifier les commits en fonction des révisions.

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.

Mise à jour du modèle de documentation

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 est : :

./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.