heavenshell / vim-jsdoc

Generate JSDoc to your JavaScript code.
BSD 3-Clause "New" or "Revised" License
452 stars 44 forks source link

Sometimes the jsdoc comment is not generated properly #26

Closed IonicaBizau closed 9 years ago

IonicaBizau commented 9 years ago

Here is a case when the comment is incorrect:

/**
 * ParentSearch
 *
 * @name ParentSearch
 * @function
 * @param path
 * @param search
 * @param options
 * @param callback {d} asd
 * @param progress {Function} The progress function.
 */
function ParentSearch(path, search, options, callback, progress) {
   // ...
}

I provided information about path, search, options and callback as well. The progress data is completed from defaults.

The first arguments descriptions and types are missing.

heavenshell commented 9 years ago

So .vimc settings are same as https://github.com/heavenshell/vim-jsdoc/issues/27#issuecomment-112117552 ? path is not matched to anything. Nothing should be to inserted.

IonicaBizau commented 9 years ago

@heavenshell Yes, same settings. I did insert custom description for path but still nothing was inserted.

heavenshell commented 9 years ago

Thx. reproduced. I'll look into it.

heavenshell commented 9 years ago

Fixed. Could you try?

/**
 * ParentSearch
 *
 * @param path {null} foo
 * @param search {}
 * @param options {}
 * @param callback {Function} The callback function.
 * @param progress {Function} The progress function.
 */
function ParentSearch(path, search, options, callback, progress) {
}
IonicaBizau commented 9 years ago

@heavenshell Nice! Works nice! :smile:

heavenshell commented 9 years ago

Thx for reporting :smile:

IonicaBizau commented 9 years ago

@heavenshell Thanks for fixing! :cake: :smile_cat: I heavily use this plugin daily. Then blah generates the documentation (README.md, CONTRIBUTING.md etc).