activeviam / react-api-documenter

4 stars 1 forks source link

Generated documentation includes function duplicates when the functions are overloaded. #7

Open NZepeda opened 3 years ago

NZepeda commented 3 years ago

Summary

Having overloaded functions such as the example below will produce function duplicates in the generated documentation:

function func(key: "dashboard"): ContentRecord<DashboardMetaData> {}
function func(key: "widget"): ContentRecord<WidgetMetaData> {}
function func(key: "filter"): ContentRecord<FilterMetaData> {}

function func(key: ContentType): ContentRecord<DashboardMetaData> | ContentRecord<WidgetMetaData> | ContentRecord<FilterMetaData> {
  ...impl
}
Nouzbe commented 1 year ago

@NZepeda is this bug still valid? I was looking for an example of bad generated documentation. One that came to mind is https://activeviam.com/activeui/documentation/latest/docs/api/hooks#usetree. But it seems to be correctly generated.

If this issue does not exist any more, could you close it?