search

angular / dgeni-packages

A collection of dgeni packages for generating documentation from source code.
MIT License
142 stars 101 forks source link

Ignoring method overloads in TypeScript #209

Closed roddolf closed 7 years ago

roddolf commented 7 years ago

The readTypeScriptModulesprocessor is ignoring all the overloads of a method and only taking in count only the first declaration.

Is there a workaround for this error?

petebacondarwin commented 7 years ago

There might be a workaround See this line of code https://github.com/angular/dgeni-packages/blob/ad2da44d859d9505704afb6d93bc51a39c50265e/typescript/processors/readTypeScriptModules.js#L183

The additionalDeclarations are added to the exportDoc so you might be able to get hold of the information you need there?

roddolf commented 7 years ago

No, the property is not set in a class or interface member. It looks like it is only added for a direct child of a module.

petebacondarwin commented 7 years ago

Hmm. I don't have time to work on this for a couple of weeks. If you want to have a crack at fixing it I will happily review.

WoMayr commented 7 years ago

any updates on this topic?

petebacondarwin commented 7 years ago

I am working on it...

petebacondarwin commented 7 years ago

This should be fixed in 0.20.0