You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To make the whole experience easier for users, I'd like to add docstrings to all user-facing variables and options.
I've started on the config_folder tool, my goal is to have a short and sweet description that ideally answers 3 questions:
What does this change about my final result?
Does this option affect Godot or Trenchbroom?
Is it optional? (Do I need to configure this for each map/project?)
If not all questions can be answered in 1-4 short sentences, link to the appropriate docs page: https://qodotplugin.github.io/
TrenchbroomGameConfig
TrenchbroomTag
TrenchbroomFaceAttrib
QodotFGDClass
QodotFGDBaseClass
QodotFGDFile
QodotFGDPointClass
QodotFGDSolidClass
QodotPlugin
QodotTextureLoader
QodotUtil
QodotMap
QodotEntity
QodotNode3D
I've written some class descriptions in https://qodotplugin.github.io/docs/class-reference (some are a bit wordy) and you are all free to copy, add, reword, and condense what's written into docstrings.
To make the whole experience easier for users, I'd like to add docstrings to all user-facing variables and options.
I've started on the config_folder tool, my goal is to have a short and sweet description that ideally answers 3 questions:
If not all questions can be answered in 1-4 short sentences, link to the appropriate docs page: https://qodotplugin.github.io/
I've written some class descriptions in https://qodotplugin.github.io/docs/class-reference (some are a bit wordy) and you are all free to copy, add, reword, and condense what's written into docstrings.
Here's how to add documentation to any property: https://docs.godotengine.org/en/latest/tutorials/scripting/gdscript/gdscript_documentation_comments.html Don't worry about adding special bbcode for now, we can always clean that stuff up later.
The text was updated successfully, but these errors were encountered: