search

nikhilmodak / gulp-ngdocs

Gulp plugin for building angularJS documentation
MIT License
95 stars 64 forks source link

Error when processing Angular ... (invalid param format) #87

Open arrgson opened 8 years ago

arrgson commented 8 years ago 
C:\...\node_modules\gulp-ngdocs\src\ngdoc.js:417
            throw new Error("Not a valid 'param' format: " + text + ' (found in: ' + self.file + ':' + self.line + ')');
            ^

Error: Not a valid 'param' format: {Function=} successCallback (found in: C:\...\bower_components\angular\angular.js:15721)

Should description be optional? Or should this be reported as an issue for Angular? (Couldn't find any mention there.)

sevem commented 8 years ago

same problem. Which format should the param looks like? I've tried several formats

rdkleine commented 8 years ago

{number} paramA This is paramA and does so and so

scotttrinh commented 8 years ago

It would be nice to support all three possible formats for @param:

  1. Name only
  2. Name and type
  3. Name, type, and description

I'd be happy to put together a PR.