Skip to content

descriptions for custom types #627

Closed Answered by JohnnyMorganz
ActualMasterOogway asked this question in Q&A
Discussion options

You must be logged in to vote

Unfortunately it is not very well documented, but you can use a documentations file alongside a definitions file.

You can find an example of such a file at https://raw.githubusercontent.com/MaximumADHD/Roblox-Client-Tracker/roblox/api-docs/en-us.json which is a DocumentationDatabase in JSON format.

To understand its structure, see https://github.com/luau-lang/luau/blob/master/Analysis/include/Luau/Documentation.h

I want to make this simpler using doc-comments inlined in source code instead. This is currently missing some Luau features to make possible. Relevant issue: #271

Replies: 1 comment

Comment options

You must be logged in to vote
0 replies
Answer selected by ActualMasterOogway
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Category
Q&A
Labels
None yet
2 participants