Skip to content

Optimize the logic to generate documentation comment #733

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

Open
DragonKnightOfBreeze opened this issue Oct 24, 2024 · 1 comment
Open

Optimize the logic to generate documentation comment #733

DragonKnightOfBreeze opened this issue Oct 24, 2024 · 1 comment
Labels
enhancement New feature or request topic:api-gen topic:documentation Improvements or additions to documentation

Comments

@DragonKnightOfBreeze
Copy link

image

  1. line break in kotlin doc should use 2 line break character ('\n'), as same as in markdown
  2. special handing logic for basic type references is required (e.g., [int], may convert to [Int])
  3. annotation references are not converted (e.g., [annotation @GDScript.@export])
  4. replace [codeblock]..[/codeblock] to markdown codefence format, it's missing
  5. missing imports for references (e.g., [Signal.emit] in Object.kt)
@CedNaru CedNaru added topic:documentation Improvements or additions to documentation enhancement New feature or request topic:api-gen labels Oct 24, 2024
@chippmann
Copy link
Contributor

@piiertho i think i handled most if not all of these cases in the old doc gen when we still manually parsed the docs from the xml files.
Maybe some of it can be salvaged for these fixes here? IIRC these sanitizing steps i did were independent of the xml data

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request topic:api-gen topic:documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants