search

Daylily-Zeleen / Godot-DragonBones

A GDExtension plugin of DragonBones for Godot 4.x
MIT License
78 stars 7 forks source link

Add documentation in the editor #11

Closed DearFox closed 5 months ago

DearFox commented 5 months ago

изображение

Daylily-Zeleen commented 5 months ago

@DearFox please describe the detail of your problem.

JekSun97 commented 5 months ago

@DearFox please describe the detail of your problem.

This is what I wrote about earlier, the documentation is severely lacking, there are many functions, and not all functions are clear

Daylily-Zeleen commented 5 months ago

This is what I wrote about earlier, the documentation is severely lacking, there are many functions, and not all functions are clear

I‘m not sure this issue is duplicate or not. Accroding to @DearFox 's image, it seems that the EditorHelp can't work correctly. The lack of documentation dose not equal to make the EditorHelp broken.

So I need more detail about what happen in this issue.

By the way, due to the limitation of GDExtension, we can't add description to EditorHelp currently.

JekSun97 commented 5 months ago

@DearFox Try to describe the action taken to create the problem, perhaps this is an error of the godot himself, and it is worth reporting there

DearFox commented 5 months ago

There are simply no descriptions of some classes. Click on one of this plugin's classes (in the code editor in godot) using ctrl and it will open this blank window. I'm using v4.2.2.stable.official [15073afe3]

Daylily-Zeleen commented 5 months ago

Which classes? How to reproduce?

DearFox commented 5 months ago

oh ok, guess I had to reboot godot and now everything works. Of course there is no description of the functions, but I can look them up.

Then I think it would be more correct to rename this issues to “please add a description for methods and functions to the documentation inside godot”

Daylily-Zeleen commented 5 months ago

Then I think it would be more correct to rename this issues to “please add a description for methods and functions to the documentation inside godot”

Please refer to this comment.

DearFox commented 5 months ago

Which classes? How to reproduce?

I meant this documentation. And it seems I just needed to restart the project with the plugin, and everything worked (not sure why I had problems before.) изображение

Daylily-Zeleen commented 5 months ago

I meant this documentation. And it seems I just needed to restart the project with the plugin, and everything worked (not sure why I had problems before.)

This is due to godot limitation, every GDExtension plugin should be loaded at least once and restart editor to make classes visiable in EditorHelp.