Allow property JSDoc overloading

[nmussy]

🚀 Feature Request

Affected Languages

• TypeScript or Javascript
• Python
• Java
• .NET (C#, F#, ...)

General Information

• JSII Version: 0.18.0

• Platform: all

• I may be able to implement this feature request

• This feature might incur a breaking change

Description

JSII throws an error when attempting to overload an interface property to change its child JSDoc: (Interface declares same member as inherited interface)

• CDK use-case: #4299 #b3597407a1217ae035772227048a21fb89896591
• Failed build log

Proposed Solution

_visitDocumentation could be used to check that the parent and child docs are different, and not throw if that's the case.

[RomainMuller]

One tidbit here is that C# does not allow re-declaring a member on a child interface, only to hide it. This means from a C# developer's perspective this results in two distinct declarations of a member with a given name, that can be implemented separately (or in tandem).

I have to check with .NET specialists on exactly how offensive it would be for us to generate new declarations for interface members that "override" declarations from a parent.

[cgatt]

This feature is important for re-writing docs when an inheriting object modifies the default value of a property.