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
Right now the GDSiON extension provides only the auto-generated documentation, containing method and property names and types, but no functional description or guidance.
GDExtensions may not support XML documentation yet, so in the meantime any other means to describe the functionality should be explored, including Markdown files and GitHub wiki.
The original SiON project has quite a lot useful comments with descriptions and examples, which can be lifted as a starting point. Note that some liberties were taken when porting certain aspects of the original implementation, so care must be applied when borrowing descriptions. I also noticed a few outdated comments/errors/copy-paste mistakes while working on the codebase.
The text was updated successfully, but these errors were encountered:
Right now the GDSiON extension provides only the auto-generated documentation, containing method and property names and types, but no functional description or guidance.
GDExtensions may not support XML documentation yet, so in the meantime any other means to describe the functionality should be explored, including Markdown files and GitHub wiki.
The original SiON project has quite a lot useful comments with descriptions and examples, which can be lifted as a starting point. Note that some liberties were taken when porting certain aspects of the original implementation, so care must be applied when borrowing descriptions. I also noticed a few outdated comments/errors/copy-paste mistakes while working on the codebase.
The text was updated successfully, but these errors were encountered: