-
-
Notifications
You must be signed in to change notification settings - Fork 23
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
should detect @example
, @public
and @private
#6
Comments
@jonschlinkert bump. I understand that adding +1 on where "the code starts" is because you write comments two lines above the code and not just right before the code as in above example, but.. That's not make sense for me, and I don't know why you do it like that, when docblocker (sublime) completes automatically code comments if you type "/**" just above/before the function/module.exports. |
mine adds a line between the comment and code. we can easily change this in the refactor I'm working on. |
Currently it won't work if you just give
@public
, instead of@api public
.Same applies for examples which works if it find
**Example**
in codeblock, but not works if find@example
this works as expected
I'm not sure if the issue is exactly for here, I can't remember but I think this module is behind verb-ish things and behind my
apidocs-cli
which usehelper-apidocs
.Another ugly thing is that it adds one line from where codeblock ends, means that tools on top of this module will show and create link to line where is the
if
statement and not where themodule.exports
is which requires you to add empty line above themodule.exports
which in some cases aren't good. For example, recently I've just tried https://inch-ci.org/, which seems to read jsdoc comments to create "documentation analytics". So it assumes that the code comment starts right before the function or in casemodule.exports
. It also assumes using@example
.The text was updated successfully, but these errors were encountered: