descriptions for custom types #627
-
How can i add a description in my type definition? |
Beta Was this translation helpful? Give feedback.
Replies: 1 comment
-
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 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 |
Beta Was this translation helpful? Give feedback.
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