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.

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

C#: Bindings generator now translates BBCode docs to XML comments #27359

Merged
merged 1 commit into from
Mar 23, 2019

Conversation

neikeq
Copy link
Contributor

@neikeq neikeq commented Mar 23, 2019

It's not perfect, but much better than what we had before.

Here's the full diff of the generated bindings: https://gist.github.com/neikeq/5298b69567a24a683a42777aa3fcdbb7

Regarding member/type/etc references, right now the following are not automatically resolved but it would be possible with some mapping:

Generating FuncRef.cs...
Cannot resolve type from method reference in documentation: @GDScript.funcref
Cannot resolve type from method reference in documentation: @GDScript.funcref

Generating GDScriptFunctionState.cs...
Cannot resolve type from method reference in documentation: @GDScript.yield
Cannot resolve type from method reference in documentation: @GDScript.yield

Generating Node.cs...
Cannot resolve method reference for non-Godot.Object type in documentation: String.match
Cannot resolve method reference for non-Godot.Object type in documentation: String.match

Generating Texture.cs...
Cannot resolve type from method reference in documentation: @GDScript.load

Generating WeakRef.cs...
Cannot resolve type from method reference in documentation: @GDScript.weakref

@neikeq neikeq added this to the 3.2 milestone Mar 23, 2019
@neikeq neikeq force-pushed the who-reads-docs-anyway branch from f35a6f6 to d115682 Compare March 23, 2019 19:23
@neikeq neikeq force-pushed the who-reads-docs-anyway branch from d115682 to 1ad16b3 Compare March 23, 2019 19:40
@neikeq neikeq merged commit e453934 into godotengine:master Mar 23, 2019
@neikeq
Copy link
Contributor Author

neikeq commented Mar 24, 2019

Marking this for cherry-picking, as it's a documentation improvement that would be great to have in the 3.1.x branch.

@akien-mga
Copy link
Member

Cherry-picked for 3.1.1.

@neikeq neikeq deleted the who-reads-docs-anyway branch May 14, 2021 01:53
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.

2 participants