peter-kish / gloot

A universal inventory system for the Godot game engine.
MIT License
561 stars 20 forks source link

Added doc comments to generate in-engine help docs #218

Closed TGRCdev closed 2 months ago

TGRCdev commented 2 months ago

This commit uses Godot's new documentation comments feature to add in-engine documentation for the classes within Gloot. I transcribed all of the files found in docs/ to their respective classes, with minimal edits or changes (which can be done in later commits). Having the documentation in-engine helps massively in iteration speed, as it not only can be quickly accessed through the help search, but also the documentation can link to other classes, methods and members when they are referenced.

image image