v1.3.1 Fast-follow

Quick bug fix from v1.3.0

Previously, the new urls used the file extension .lua.lua. That is fixed in this release to just use .lua.

v1.3.0 - Link back to source files

Now, if you include the a repository url as one of the parameters in the action, a link will be automatically generated for every function that will send you to the source code for that function.

If your repository is hosted on GitHub, you will even get directed to the exact line number of function and it will be highlighted.

Fast-follow bug fix

Quick bug fix from v1.2.0

The improved TOC accidentally adds each new item into the same paragraph instead of having them break on each line.

Improve documentation ergonomics

This release has 3 main changes:

• Improve table of contents
• Fix links in table of contents
• Allow multiple return values

Improved table of contents

The current table of contents simply lists the names of each method. This means that while the names of each methods are scannable, their usage is not.

- [method_one](#method_one)
- [method_two](#method_two)

• method_one
• method_two

Now, their usage is much more obvious in the table of contents:

[method_one(arg1, arg2)](#method_one)
[method_two()](#method_two)

method_one(arg1, arg2)
method_two()

Fix links in table of contents

Previously, if a function name contained uppercase letters, the resulting link would also contain uppercase letters. This created broken links when used with other markdown parsers. Now, the links will always be lowercase.

<!-- previous -->
[UI_method(arg1, arg2)](#UI_method)

<!-- new -->
[UI_method(arg1, arg2)](#ui_method)

Allow multiple return values

Previously if you had multiple return values, only the first one would be included in the resulting Markdown. Now, all return values are included.

Automatically add args to call signature

Previously, you had to manually add all arguments to the call signature in your documentation comments. This lead to maintenance issues where the args in the call signature would become out of date with the actual function (or worse, with the listed arguments in the same documentation comment!).

--[[
% chromatic_transposition(arg1, arg2)
--]]

Now, all arguments will automatically be added. That means you can just write this:

--[[
% chromatic_transposition

@ arg1 (string) this does something
@ arg2 (number) this does something else
--]]

And the applicable documentation (with call signature) will be created:

---

chromatic_transposition

chromatic_transposition(arg1, arg2)

Input	Type	Description
arg1	string	this does something
arg2	number	this does something else

---

Note, this is not a breaking change. Any call signatures in the current documentation comments will silently be ignored. That means the resulting docs may be different—but they'll be more accurate.

v1.0.6

2 changes:

• If a Lua file doesn't have markdown, then a markdown file won't be created
• The | character is now properly escaped in tables

v1.0.5

Before, if there weren't blank lines between params and outputs, they would be included in the same table.

--[[
@ input (number)
: (number)
]]

Input	Type	Description
input	number
Output type	Description
---	---
number

Now, they are correctly separated as you'd expect.

Input	Type	Description
input	number

Output type	Description
number

v1.0.4

Create better detection for parameters, outputs, headers, modules, etc. and eliminate all falsely thrown errors. Now, the same code used to parse the items are used to detect them.

v1.0.3

Create support for parameters and outputs of multiple types.

--[[
@ input (string | number) the input can either be a string or a number

: output (string | number) the return value can either be a string or a number
]]

--[[
: output (string, number) in this case, there are two return values, on a string and one a number
]]

v1.0.2

If you used the previous release, upgrade to this one—did not update build final build for previous release.