Documentation improvements

[nlepage]

Description

Aliases

JsDoc doesn't allow the creation of synonyms for a function. JsDoc's @alias has been designed to "to treat all references to a member as if the member had a different name", but not rhe creation of synonyms. lodash uses docdown, which has been tweaked to process @alias as a list of synonyms.

Runnable examples

All examples of the documentation should be runnable using runkit. This is the case in lodash's documentation, I don't know how it is done.

External references

Have the ability to reference a function regardless of the version. For now the functions are organized in namespaces, and the namespace is part of the path in the URL : https://zenika.github.io/immutadot/immutadot/0.2/array.html#concat This forces to put also the version in the URL. The namespace would be better placed in the hash of the URL, allowing shorter links : https://zenika.github.io/immutadot#array.concat Which would redirect to the latest version of the documentation. Lodash uses @category instead of @namespace to do this.

TODO

• Have a look at doclets.io which seems to fulfill at least the Runnable examples and External references...