You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I just tried out typedoc and really like it thus far. Unfortunately there are some flaws I don't understand yet which I'd like to know more about. For testing purposes I used the source files from the following folder structure:
When I ran typedoc for the first time I got this output:
Basically every single TypeScript file was considered a single module in itself, even though I have one and only one type/class/interface per file. After turning on --mode file I got the following output:
In the second example it is unfortunate that there is no way to distinguish which folders the specific classes/interface come from. This is even more obvious when adding another class with the same name in another folder. Although bad in design, it can actually happen in a library that is big enough. What happens is, that typedoc merges all classes/enums/interfaces with the same name and only creates one bullet point with all members and documentation comments merged.
The only useful plugin I found thus far is asgerjensen/typedoc-plugin-external-module-map which allows some minor grouping. In fact I consider that particular plugin to be useful to create a documentation for multiple projects that get grouped using the plugin.
I'd like to know whether you are aware of the documentations that erroneously get merged and would like to know which options or plugins I can leverage to bring some order into this chaos.
The text was updated successfully, but these errors were encountered:
Hello @nearautomata, thanks for bringing up these points. Right now typedoc does not handle a directory structure very well but it is something that would be great to support better in the future. I'll close this as a duplicate of #379
I just tried out



typedoc
and really like it thus far. Unfortunately there are some flaws I don't understand yet which I'd like to know more about. For testing purposes I used the source files from the following folder structure:When I ran
typedoc
for the first time I got this output:Basically every single TypeScript file was considered a single module in itself, even though I have one and only one type/class/interface per file. After turning on
--mode file
I got the following output:In the second example it is unfortunate that there is no way to distinguish which folders the specific classes/interface come from. This is even more obvious when adding another class with the same name in another folder. Although bad in design, it can actually happen in a library that is big enough. What happens is, that
typedoc
merges all classes/enums/interfaces with the same name and only creates one bullet point with all members and documentation comments merged.The only useful plugin I found thus far is asgerjensen/typedoc-plugin-external-module-map which allows some minor grouping. In fact I consider that particular plugin to be useful to create a documentation for multiple projects that get grouped using the plugin.
I'd like to know whether you are aware of the documentations that erroneously get merged and would like to know which options or plugins I can leverage to bring some order into this chaos.
The text was updated successfully, but these errors were encountered: