jQuery.ajax parameters that are reported as undocumented

inch-ci / inch_ci-web

Web frontend for Inch CI

http://inch-ci.org/

MIT License

139 stars 20 forks source link

jQuery.ajax parameters that are reported as undocumented #59

Open Aymkdn opened 9 years ago

Aymkdn commented 9 years ago

Hi,

I use some jQuery code in my project and Inch says I should document "beforeSend" that is used into "jQuery.ajax".... as well as "success", "error" and "after". They are the params of jQuery.ajax so I don't see any reasons for me to document them.

Thoughts?

My Inch page: Aymkdn/SharepointPlus

rrrene commented 9 years ago

Hi, sorry for not getting back to you.

Yeah, this is still a problem. I'm currently using JSDoc for JS parsing and I still have to figure out how to differentiate between "important to document" functions and callbacks.

Thanks for the bug report and I will do my best to figure something out for the next release!