Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
rognoni opened this issue Apr 12, 2016 · 2 comments
Open

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

rognoni opened this issue Apr 12, 2016 · 2 comments

Comments

@rognoni
Copy link

rognoni commented Apr 12, 2016

For example:

/****
 * string-format
 * https://github.com/davidchambers/string-format
 *
 * @author David Chambers <dc@davidchambers.me>
 * @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

@davidchambers
Copy link
Owner

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.

@rognoni
Copy link
Author

rognoni commented Apr 13, 2016

@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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants