angular / dgeni-packages

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

fix(api-doc-types): ParameterDoc incorrectly extends ExportDoc #262

Closed devversion closed 6 years ago

devversion commented 6 years ago

Fixes #261

petebacondarwin commented 6 years ago

Oops, I meant that the interface should stay the same and we should insert a new class BaseApiDoc between the interface and the ExportDoc. This would also avoid the BC.

devversion commented 6 years ago

@petebacondarwin I see. Updated the PR to no longer include the breaking change. Let me know if you still want me to change that lack-of declaration comment.

devversion commented 6 years ago

I agree with the separation of the BaseApiDoc class, the fix for the ParameterDoc and the line feed change. It was just more convenient to change stuff as part of the big change, because otherwise it would likely end up in merge conflicts.

About the BaseApiDoc. I didn't really expect this to be announced as a feature, because it's more likely being used internally only.

devversion commented 6 years ago

@petebacondarwin Just tried to do what you proposed. Although I included the TypeScript style changes into the ParameterDoc commit because otherwise, it would be more work to reorganize the imports for the individual commits. Hope that's fine like that.