GD-827: Jump to GdUnit4 API functions online documentation context-sensitive

[MikeSchulze]

Feature Type

IDE/Editor integration

Problem/Use Case

When a user is unfamiliar with the API it needs to jump to the documentation page to search for a certain assertion function to read about usage and finding examples.
The GdUnit4 inspector has a button to jump to the documentation main page, where helps to start reading documentation.

It would be nice to have a solution to jump to a specific documentation context-sensitive.

Proposed Solution

Solution A

Extend the text editor context menu by a new entry "documentation", to be open the online documentation based on the current cursor position.
It should only show an active "documentation" entry if the cursor stays on a GdUnit4 API function.

Solution B

Alternative, extend the editor help popup for a function to add a button to jump to the online documentation.

Alternatives Considered

Currently, we have to open the online documentation by pressing the “doc” button and search for functions or manually navigate the page to find something.

Impact and Benefits

Solution A

It would be simple to extend the GdUnit4 context menu.

Solution B

Needs research how to hook into the Godots text editor help popup.

function reference mapping

Needs to build a hash map to map all API functions to the online documentation as link.
It would be good to have an automated tooling to generate the documentation links on the fly to avoid maintenance effort for new or changed API functions.

Implementation Notes

No response

Examples and References

No response

Contribution

• I'm willing to contribute code for this feature
• I'm willing to help with testing/feedback
• I'm willing to help with documentation
• I would just like to request this feature