Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

docs: 📝 Rewrote API class comments #279

Merged
merged 6 commits into from
Jun 17, 2023

Conversation

KANAjetzt
Copy link
Member

Rewrote comments in the following classes to facilitate automatic API documentation generation using gdscript-docs-maker:

  • ModLoaderConfig
  • ModLoaderDeprecated
  • ModLoaderLog
  • ModLoaderMod
  • ModLoaderUserProfile

The goal is to further extend this to include the Resource classes and potentially the internal classes as well.



works towards #254

@KANAjetzt KANAjetzt added the documentation Improvements or additions to documentation label Jun 16, 2023
@KANAjetzt KANAjetzt added this to the v6.0.0 milestone Jun 16, 2023
@KANAjetzt KANAjetzt self-assigned this Jun 16, 2023
@KANAjetzt KANAjetzt changed the title Docs v6 docs: 📝 Rewrote API class comments Jun 16, 2023
Copy link
Collaborator

@Qubus0 Qubus0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

very thorough. i like it.
a few little things, but already good to go

@KANAjetzt KANAjetzt added this pull request to the merge queue Jun 17, 2023
Merged via the queue into GodotModding:development with commit a01a703 Jun 17, 2023
@KANAjetzt KANAjetzt deleted the docs_v6 branch June 19, 2023 11:11
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants