angular/dgeni-packages

Support all jsdoc tags

rochdev opened this issue · 4 comments

Several jsdoc tags including but not limited to @extends / @augments are causing "Invalid tags found" warnings. Since these are official jsdoc tags, they should be supported by the processor.

It is easy enough to add such tags into your own dgeni configuration, see how it is done here:

https://github.com/angular/dgeni-packages/blob/master/ngdoc/index.js#L26-L29

You just define a tag definition and add it to the list of definitions that you expect the tagParser to read.

We didn't add extends and augments because they are not used in the current angular docs.

@petebacondarwin Would you mind if I make a pull request to add official support? I really think support should be built-in even though the angular docs don't need it.

Sure, please do. You could also add @enum while you are at it. Thanks

I think we are mostly there now. If there are any more specific tags that we should cover then please submit specific issues for them.