This has been added And the OP has been updated to have an image of this update.
I agree - thatās why this update changed to accommodate that. Now if you have erroneous documentation comments, youāll get a warning in your output every time you select the script in Explorer, but the rest of the comments should load properly regardless.
Nice plugin ! I would love if I can say for example < type > and that the plugin will highlight the type So that I can say @returns < int > or @returns < table >
Itās an easy enough addition to make, but Iād need convincing on why this makes sense for a weakly typed language like Lua? Could you offer any examples of where this is useful?
You can now add a āvalue-typeā attribute to your parameters and return values. Here is an example in Rodocs:
--[[**
Some function
@param [t:number] bar Some random number
@param addend Another number, but notice that the value type is not listed. That's because it is optional.
@returns [t:number] The sum of the two numbers
**--]]
function foo(bar, addend)
return bar + addend
end
For the XML style, please reference the help documents that can be brought up using the help button
Now when you select a script, you will have the option to āGenerate markup.ā In the future, I plan to implement multiple markup languages, which will be another setting. For now, there is only Markdown.
This is a really awesome addition for GitHub repositories Hopefully this helps to incentivize people to add Rodocs comments to their open source libraries since it will auto-generate Markdown now
I just documented my RbxWeb module with this, and itās so much better now. This plugin is absolutely amazing if you dedicate the time to documenting all of your code.
I did notice a bug with the plugin where it wasnāt showing documentation until I refreshed my plugins. It wasnāt even showing an error either. Iāll update this comment with a picture of it if it happens again.
This plugin is great, Iāve been documenting all my scripts with it. I have one thing to nitpick though; it only allows for one return value and even gives a warning in the output about it.
Having multiple doc tags of type returns is not allowed.
I find this silly because itās natural for Lua functions to return multiple values, or a tuple.
This is a great plugin, it has really helped keep me sane when working with large codebases. I do have two suggestions though. Firstly, could you consider adding a setting to hide the Swap and Help buttons (and maybe an option to move the Settings button to the reader)? My plugin bar is getting really cluttered and I want to minimize that as much as possible. I could edit the script, but I donāt want to miss out on any updates. Secondly, can you enable ClickableWhenViewportHidden on the toolbar buttons? (Sorry for the necro)