Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Add documentation to the Background and Audio subsystem #2122

Merged
merged 21 commits into from
Mar 10, 2024

Conversation

CakeVR
Copy link
Collaborator

@CakeVR CakeVR commented Mar 2, 2024

There were numerous public methods, signals, and variables undocumented, resulting in hard-to-understand class reference.

The worst offender are the signals accepting a Dictionary, without documentation, they are opaque.

For reference, this is Dialogic's online class reference: https://docs.dialogic.pro/class_index.html

@CakeVR CakeVR added Documentation 📚 Improvements or additions to documentation Enhance ⚡ Improve a feature's workflow. labels Mar 2, 2024
@CakeVR CakeVR changed the title Add documentation to the Background and Audio subsystem Draft: Add documentation to the Background and Audio subsystem Mar 2, 2024
@CakeVR CakeVR changed the title Draft: Add documentation to the Background and Audio subsystem DRAFT: Add documentation to the Background and Audio subsystem Mar 2, 2024
Copy link
Collaborator

@Jowan-Spooner Jowan-Spooner left a comment

Choose a reason for hiding this comment

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

Some nitpicks. Overall very nice. Thanks.

addons/dialogic/Modules/Audio/subsystem_audio.gd Outdated Show resolved Hide resolved
addons/dialogic/Modules/Audio/subsystem_audio.gd Outdated Show resolved Hide resolved
addons/dialogic/Modules/Audio/subsystem_audio.gd Outdated Show resolved Hide resolved
addons/dialogic/Modules/Save/subsystem_save.gd Outdated Show resolved Hide resolved
addons/dialogic/Modules/Voice/subsystem_voice.gd Outdated Show resolved Hide resolved
addons/dialogic/Modules/Voice/subsystem_voice.gd Outdated Show resolved Hide resolved
addons/dialogic/Modules/Voice/subsystem_voice.gd Outdated Show resolved Hide resolved
addons/dialogic/Modules/Voice/subsystem_voice.gd Outdated Show resolved Hide resolved
addons/dialogic/Modules/Voice/subsystem_voice.gd Outdated Show resolved Hide resolved
@CakeVR CakeVR changed the title DRAFT: Add documentation to the Background and Audio subsystem Add documentation to the Background and Audio subsystem Mar 5, 2024
Copy link
Collaborator

@Jowan-Spooner Jowan-Spooner left a comment

Choose a reason for hiding this comment

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

Small notes, otherwise great additions across the board!

addons/dialogic/Core/DialogicGameHandler.gd Outdated Show resolved Hide resolved
addons/dialogic/Modules/Audio/subsystem_audio.gd Outdated Show resolved Hide resolved
@Jowan-Spooner
Copy link
Collaborator

Great stuff!

@Jowan-Spooner Jowan-Spooner merged commit 64ca5cf into dialogic-godot:main Mar 10, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation 📚 Improvements or additions to documentation Enhance ⚡ Improve a feature's workflow.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants