allenhwkim / angular-jsdoc

AngularJS Template/Plugin for JSDoc 3.
MIT License
148 stars 57 forks source link

'Type' column is empty #87

Open plwade opened 8 years ago

plwade commented 8 years ago

Controller parameter Type is always empty. I have attached a screenshot and controller code.

Any help appreciated. jsDocTest.controller.txt capture

molikmiah commented 8 years ago

I am having the same issue, i have also tried to use @type and adding the {type} before and after the variable/object name with no success.

Even if i copy the code in the example controller it doesn't include type. Could this be an issue with the JSDoc version?

plwade commented 8 years ago

The example code does not put the Type before the name https://github.com/allenhwkim/angular-jsdoc/blob/master/sample-codes/ngmap/map-controller.js

[https://avatars0.githubusercontent.com/u/1437734?v=3&s=400]https://github.com/allenhwkim/angular-jsdoc/blob/master/sample-codes/ngmap/map-controller.js

allenhwkim/angular-jsdochttps://github.com/allenhwkim/angular-jsdoc/blob/master/sample-codes/ngmap/map-controller.js github.com angular-jsdoc - AngularJS Template/Plugin for JSDoc 3.

eg. * @param GeoCoder {service} Google GeoCoder wrapper

Please could you provide some example code re. {type} before the name

Kind Regards,

Paul


From: Florian Zemke notifications@github.com Sent: 25 May 2016 20:27 To: allenhwkim/angular-jsdoc Cc: plwade; Author Subject: Re: [allenhwkim/angular-jsdoc] 'Type' column is empty (#87)

Type has to be first before the param name.

@molikmiahhttps://github.com/molikmiah, Could you please provide example code?

You are receiving this because you authored the thread. Reply to this email directly or view it on GitHubhttps://github.com/allenhwkim/angular-jsdoc/issues/87#issuecomment-221696805

jukebox017 commented 7 years ago

In my case, I am using docdash as my template, and the type column was empty. The type was being parsed correctly from @param in ngdoc.js. However, it was stored in the property "typeDefinition" and "typeDefinitionUrl", and docdash was expecting to find a property of "type", with an additional property "names" within "type".

In order to make the types appear for now, I added the following to ngdoc.js near the bottom of parseParamTypes:

result.type = {}
result.type.names = [result.typeDefinition];
wayrex commented 6 years ago

Any news on that issue?