add type info to jsdoc params

[lipp]

Jsdoc params should be documented like this:

/**
 * Bla
 * @param {String} The foo in the game
 * @param {Number} [index=0] The first foo index
 * @return {String[]} All the foos as array
 */

Nice to have: add examples from Markdown to JSDoc comment

/**
 * @playground
 * var slugify = require('strman').slugify;
 * let title = "A Javascript string manipulation library.";
 * let result = slugify(title);

to get output like this:
https://doclets.io/dleitee/strman/master#dl-slugify

[dleitee]

Very well.
Now that this divide the functions not to generate conflict?
I will describe here which functions I'll document.

• safeTruncate
• truncate
• removeEmptyStrings
• format
• compare
• equal
• inequal
• hexEncode
• hexDecode
• binEncode
• binDecode
• decEncode
• decDecode
• urlEncode
• urlDecode
• base64Encode
• base64Decode
• htmlDecode
• htmlEncode

[lipp]

ok. i'll start [a-e] from the available functions (markdown). probably have time tomorrow evening...

which is:

• append
• appendArray
• at
• between
• chars
• collapseWhitespace
• contains
• containsAll
• containsAny
• countSubstr
• endsWith
• ensureLeft
• ensureRight

[lipp]

@dleitee First part done. Hope you like it ! #36

https://doclets.io/lipp/strman/add-to-doclets

[dleitee]

@lipp PR #36 merged.

[dleitee]

• first
• indexOf
• insert
• isLowerCase
• isString
• isUpperCase
• last
• lastIndexOf
• leftPad
• leftTrim
• length
• prepend
• prependArray
• removeLeft
• removeNonWords
• removeRight
• removeSpaces
• repeat
• replace
• reverse
• rightPad
• rightTrim
• slice
• split
• startsWith
• substr
• surround
• toCamelCase
• toDecamelize
• toKebabCase
• toLowerCase
• toSnakeCase
• toStudlyCaps
• toUpperCase
• transliterate
• trim