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
Any sort of game that uses some of Godot's less documented features
Describe the problem or limitation you are having in your project
An easy way to find the relevant source file from the editor documentation tool
Describe the feature / enhancement and how it helps to overcome the problem or limitation
Adding a link to the source or a way to view the source code for a class could help understand how a class works.
Describe how your proposal will work, with code, pseudo-code, mock-ups, and/or diagrams
A simple option could be to just link to the github page for the code. A more complicated version could show the source code in the documentation page perhaps like rust's documentation viewer does.
If this enhancement will not be used often, can it be worked around with a few lines of script?
No, there will have to be a modification to the editor
Is there a reason why this should be core and not an add-on in the asset library?
Requires a modification to the editor
The text was updated successfully, but these errors were encountered:
This can likely be implemented in a more direct manner than godotengine/godot-docs#4314 (comment) proposed by keeping a reference to the source file for each class as a top-level attribute to the XML file. This can surely be achieved using the __FILE__ C++ macro in the GDCLASS() macro, turning into a path relative to the repository root and ensuring doc_data.cpp can read it somehow.
We can then open the correct page on GitHub by checking the current engine version and setting the branch/tag accordingly. If you want to open local source code instead, we could have an editor setting where you define the folder of a Godot source repository, which would make it open a local file instead of GitHub. (This can also be used for the "Open C++ Source" menu actions in the Debugger > Errors tab.)
Describe the project you are working on
Any sort of game that uses some of Godot's less documented features
Describe the problem or limitation you are having in your project
An easy way to find the relevant source file from the editor documentation tool
Describe the feature / enhancement and how it helps to overcome the problem or limitation
Adding a link to the source or a way to view the source code for a class could help understand how a class works.
Describe how your proposal will work, with code, pseudo-code, mock-ups, and/or diagrams
A simple option could be to just link to the github page for the code. A more complicated version could show the source code in the documentation page perhaps like rust's documentation viewer does.
If this enhancement will not be used often, can it be worked around with a few lines of script?
No, there will have to be a modification to the editor
Is there a reason why this should be core and not an add-on in the asset library?
Requires a modification to the editor
The text was updated successfully, but these errors were encountered: