Skip to content
This repository has been archived by the owner on Aug 15, 2024. It is now read-only.

Generated types and functions lack documentation #1

Open
lrockreal opened this issue Nov 28, 2023 · 2 comments
Open

Generated types and functions lack documentation #1

lrockreal opened this issue Nov 28, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@lrockreal
Copy link
Owner

Luau LSP's doc comments do not work in definition files. Instead, you are asked to create documentationFiles for your definitionFiles' types, however the only piece of written information I could find on how to write one is from an old release changelog. Most of the syntax is clear but the changelog doesn't clarify what scope types should be put under. (@roblox/global/whatever)

This could probably be solved with an issue in JohnnyMorganz' repository but I'm putting it off until later.

@lrockreal lrockreal added the documentation Improvements or additions to documentation label Nov 28, 2023
@lrockreal lrockreal self-assigned this Nov 28, 2023
@lrockreal
Copy link
Owner Author

Fortunately, somewhere in time I abandoned this project and now, I did find out how documentationFiles worked. Unfortunately, I don't remember. Still open.

@lrockreal
Copy link
Owner Author

lrockreal commented May 12, 2024

After some more searching I found the example I was talking about, and I also found with it this link to the scheme used by luau-lsp for parsing documentation. The only step now is to write/generate the documentation itself.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant