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.

Sign up for GitHub

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

Jump to bottom

Generate Orchestration script documentation #384

Open
Naros opened this issue Jun 6, 2024 · 2 comments · May be fixed by #388
Open

Generate Orchestration script documentation #384

Naros opened this issue Jun 6, 2024 · 2 comments · May be fixed by #388
Labels
cherrypick:2.0 Requires cherry-pick to Orchestrator 2.0 kind/enhancement New feature or request
Milestone
2.2

Comments

@Naros
Copy link
Member

Naros commented Jun 6, 2024

Description

A developer should be able to search for an Orchestration by its filename, much like an unnamed GDScript class and to view its associated documentation like other script languages, i.e.:

image

Implementation ideas

This requires four changes:

  1. OScriptLanguage::get_type() should return OScript::get_class_static() rather than Orchestrator.
  2. The language's icon should be registered with OScript::get_class_static() in plugin.cpp.
  3. OScriptLanguage::_supports_documentation() should return true.
  4. OScript::_get_documentation() should return the documentation metadata.
@Naros Naros added kind/enhancement New feature or request cherrypick:2.0 Requires cherry-pick to Orchestrator 2.0 labels Jun 6, 2024
@Naros Naros added this to the 2.1 milestone Jun 6, 2024
@Naros
Copy link
Member Author

Naros commented Jun 6, 2024

A few extra noteworthy points:

  • The OScript / Orchestration should support storing a brief & long description.
  • The OScript / Orchestration should support several flags: Deprecated & Experimental
  • The OScriptFunction should support a description field.
  • The OScriptSignal should support a description field.
  • The PoC work in script_docdata.h / script_docdata.cpp requires amending for serializing method default values.

Naros added a commit to Naros/godot-orchestrator that referenced this issue Jun 8, 2024
@Naros
CraterCrashGH-384 Support script documentation
fd4e2e1
@Naros Naros linked a pull request Jun 8, 2024 that will close this issue
Open
1 task
@Naros Naros modified the milestones: 2.1, 2.2 Jun 8, 2024
@Naros
Copy link
Member Author

Naros commented Jun 8, 2024

I am moving this to the Orchestrator 2.2 timeline, as this likely won't be added until Godot 4.4.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
cherrypick:2.0 Requires cherry-pick to Orchestrator 2.0 kind/enhancement New feature or request
Projects
None yet
Milestone
2.2
Development

Successfully merging a pull request may close this issue.

GH-384 Support script documentation Naros/godot-orchestrator
1 participant
@Naros