Type aliases get collapsed down into the underlying type.
jpeach opened this issue · comments
James Peach commented
Over in service-apis, we have a CRD that uses Go type aliases:
type ConfigMapsDefaultLocalObjectReference struct {
...
}
type GatewayClassParametersObjectReference = ConfigMapsDefaultLocalObjectReference
type RouteHostExtensionObjectReference = ConfigMapsDefaultLocalObjectReference
type RouteActionExtensionObjectReference = ConfigMapsDefaultLocalObjectReference
Each alias has unique doc comments describing how it should be used in context.
What happens is that a single documentation block for ConfigMapsDefaultLocalObjectReference
gets generated, and it takes the comments from one of the aliases.
What I'm hoping for is for each alias to emit its own unique documentation, and probably inline the fields of the type it is aliasing.
James Peach commented
Looks like gengo is doing the type alias flattening, see kubernetes/gengo#180