string-format icon indicating copy to clipboard operation
string-format copied to clipboard

Missing header: author, version, license, ...

Open rognoni opened this issue 9 years ago • 2 comments

For example:

/****
 * string-format
 * https://github.com/davidchambers/string-format
 *
 * @author David Chambers <[email protected]>
 * @link http://davidchambers.me
 * @version 0.5.0
 *
 * Released under MIT License. See LICENSE.txt or http://opensource.org/licenses/MIT
*/

https://github.com/rognoni/adaptable/blob/master/Front-end/HTML5-Bootstrap4/ext/string-format.js

rognoni avatar Apr 12 '16 14:04 rognoni

I'm happy to add something like this. Is this a standard header? If so, where is it described. I'd like to know, for example, what @link means in this context.

davidchambers avatar Apr 13 '16 04:04 davidchambers

@davidchambers this format is only an example from this other external library that I'm using:

https://github.com/rognoni/adaptable/blob/master/Front-end/HTML5-Bootstrap4/ext/grapnel.min.js

Probably Grapnel uses the JSDoc syntax:

http://usejsdoc.org/tags-inline-link.html

rognoni avatar Apr 13 '16 11:04 rognoni