angular / dgeni-packages

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

TypeScript: Aliased exports should include aliased name #248

Closed devversion closed 6 years ago

devversion commented 6 years ago

Let's consider this example:

  export {ObserveContent} from './X';

  /** @deprecated */
  export {ObserveContent as CdkObserveContent} from './X';

This is a common pattern inside of Angular Material, but causes Dgeni to generate documents for both exports.

The second document is identical to the original Dgeni document and doesn't even show the aliased name. It would be useful to have a property that indicates that the given doc is an alias and maybe also refer to the original document.

This issue is mostly for tracking inside of Angular Material (already mentioned on Slack).

petebacondarwin commented 6 years ago

Yes, we need to fix this. I will try to spend some time on it later this week (or early next week).

petebacondarwin commented 6 years ago

See #253

petebacondarwin commented 6 years ago

See #253