1.10

This release drafts a few changes, improvements and fixes.

• Code blocks (in @examples) can now be multi-line.
• Methods, properties and typedefs are able to add example code, like usage definition.
• @returns and @type fields with spaces are now formatted correctly.

1.9

This release drafts a change to the Overview configuration.

Instead of the config being an array, it's now a key/value object: with as key the displayable name and the filename as value.

For categories, prefix the key with a # (and still make it unique) and the value will be the category label.

1.8

This release drafts the implementation of the Overview configuration.

When set, the documentations will create a custom index given the order of the array (regardless if the Markdown file exists).

Add titles to the overview by prefixing the array entry with a #, like #Foo.

1.7

This release drafts the fix of pre-spacing in the type definition while defining parameters.

In previous releases, this would mess up the formatting:

@param {DataStore<String, Connection>} libs Store of libraries.

It would get converted into a table like the following.

Connection>} | DataStore<String, | libs Store of libraries.

Now, it would correctly implement the spaces in the type definition.

1.6

This release drafts the implementation of a few visual changes, essentially:

• Parameters, using @param, that are prefixed with an underscore (_) will get hidden in the argument table (i.e. _Connection).
• Adding the @link tag to a comment would result in @type, @returns and @extends to have a reference to the link, like Returns {[String](https://example.com/)} A string that... for example.

1.5

This release drafts support for files with the same name as the ones you're referring to, doing so by inputting the file paths into the configuration.

This does not yet mean that you can have documentation for a multiple of the same file names.

1.4

This release drafts the implementation of static support.

Now, static class methods will get parsed correctly, like async. Both can also get combined.

1.3

This release drafts a few fixes and some implementations.

Formatting is now right when there are extra spaces, and everything related to the config is stable.

As for additions, there's now also a constructor table.

1.2

This release drafts a few fixes related to the links in the documentation. Please see the example configuration and replicate it.

I will try my best to create a good URL parser, but for now, it's just adding the path to the base URL.

This release also introduces a boolean option in the configuration! It tells the formatter whether or not to include a "start" option, which goes to your Index.md starter file (like a documentation introduction).

1.1

This release drafts the implementation of typedefs and also typings files!

A new option has been added to the configuration, the Typedef. This is an array with file names you'd like to include as types, but were they not mentioned in the Keys Path file, or the Keys array.