Skip to content

Fix minor inconsistencies and errors in gdextension_interface.h#107788

Merged
Repiteo merged 1 commit into
godotengine:masterfrom
dsnopek:gdextension-interface-minor-adjustments
Jun 23, 2025
Merged

Fix minor inconsistencies and errors in gdextension_interface.h#107788
Repiteo merged 1 commit into
godotengine:masterfrom
dsnopek:gdextension-interface-minor-adjustments

Conversation

@dsnopek
Copy link
Copy Markdown
Contributor

@dsnopek dsnopek commented Jun 21, 2025

I've been working on a script to parse gdextension_interface.h (which is something a number of language bindings do!) and in the process I've discovered some minor errors and inconsistencies.

These include:

  • Incorrect argument names in doc comments
  • Forgetting information after @return
  • Putting trailing docs after interface function definitions, when we have a whole doc block above it
  • Using raw function pointer types in structs or as arguments, rather than typedefing a type for them

None of these are functional changes - only cosmetic. But just to be sure, I've run the godot-cpp tests using this modified header in both Godot and godot-cpp. Everything still works :-)

@dsnopek dsnopek added this to the 4.5 milestone Jun 21, 2025
@dsnopek dsnopek requested a review from a team as a code owner June 21, 2025 02:23
@dsnopek dsnopek force-pushed the gdextension-interface-minor-adjustments branch from 5147690 to 413eade Compare June 21, 2025 13:55
Copy link
Copy Markdown
Member

@Ivorforce Ivorforce left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@dsnopek dsnopek force-pushed the gdextension-interface-minor-adjustments branch from 413eade to d5eb669 Compare June 22, 2025 12:56
@vnen
Copy link
Copy Markdown
Member

vnen commented Jun 22, 2025

I was going to comment about this but forgot. I noticed it recently when working with Xcode since it does give a bunch of warnings because of the inconsistencies.

@Repiteo Repiteo merged commit 97f4b8a into godotengine:master Jun 23, 2025
20 checks passed
@Repiteo
Copy link
Copy Markdown
Contributor

Repiteo commented Jun 23, 2025

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants