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

enh(api-gen): generate kdoc from api json #534

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

piiertho
Copy link
Member

@piiertho piiertho commented Nov 7, 2023

This removes xml kdoc generation by using doc provided in api json.
To generate a new api use --dump-extension-api-with-docs engine argument.

}
}

fun TypeSpec.Builder.addKdoc(documented: IDocumented): TypeSpec.Builder {
Copy link
Member

Choose a reason for hiding this comment

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

Those 3 types implement the Documentable interface, you can just define a generic extension <T: Documentable.Builder> for it instead of implementing 3 different ones.

"method"
)

private val tagsToSanitize = arrayOf(
Copy link
Member

@CedNaru CedNaru Nov 7, 2023

Choose a reason for hiding this comment

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

I would also add handling of the [gdscript] [csharp] [codeblock] tags in the sanitizer.

@CedNaru CedNaru linked an issue Nov 7, 2023 that may be closed by this pull request
@piiertho piiertho force-pushed the enhancement/generate-doc-from-api-json branch 2 times, most recently from 2950ba7 to f26a1bf Compare November 12, 2023 13:47
Base automatically changed from chore/update-to-godot-4.2 to master December 16, 2023 17:21
@piiertho piiertho force-pushed the enhancement/generate-doc-from-api-json branch from f26a1bf to 3944552 Compare December 21, 2023 08:23
* sub-animation and return once it finishes. Blend times for fading in and out can be customized, as
* well as filters.
* After setting the request and changing the animation playback, the one-shot node automatically
* clears the request on the next process frame by setting its `request` value to [ONESHOTREQUESTNONE].
Copy link
Contributor

Choose a reason for hiding this comment

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

ONESHOTREQUESTNONE something is off here. this should be ONE_SHOT_REQUEST_NONE

@CedNaru CedNaru closed this Apr 21, 2024
@CedNaru CedNaru deleted the enhancement/generate-doc-from-api-json branch April 21, 2024 06:09
@CedNaru CedNaru restored the enhancement/generate-doc-from-api-json branch April 21, 2024 06:21
@CedNaru CedNaru reopened this Apr 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generate documentation from the api.json file.
3 participants