-
Notifications
You must be signed in to change notification settings - Fork 194
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
Override detected code with jsdoc directives? #179
Comments
If a tag is defined in the comment which matches something we infer, it absolutely should override the inferred meaning. So if that's not happening then something's wrong. I would have to see the actual json being produced to chase down that issue, tho. |
Well, in my case, the tag doesn't match the inferred thing, so it's ignored. So, what I mean is (what I would like), if I say something is a As with the above example, dox seems to ignore it because (as you said) the I think it's a good case to prioritize comments over code because in reality there's no way we can infer all code cases (as in my example, but there are many more). (I'm also not sure |
I guess what I'd want in my case is to write |
It's been a while, but I'll be coming back to dox!
Question: does dox look at the comments when it can't infer from the code? Can we make it prioritize the comments over the code?
For example, I have
Since Angular directives aren't a standard JS thing, I thought I'd just use the
@class
jsdoc directive to document it (in Angular 2 they are classes anyways). I'm using dox 0.8.1 indox-foundation
, but the class docs don't show up. For example, here's what an actual ES6 class doc looks like in dox-foundation:But, here's what happens with the above sample code:
which leads me to believe that the JSON that
dox
returns todox-foundation
is different in that case, which is why dox-foundation renders it differently. Is there (maybe we can add) an option to prioritize comments over code?The text was updated successfully, but these errors were encountered: