Giters

christopherthielen / typedoc-plugin-external-module-name

Specify the Typedoc Module of a file using @module annotation

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[QUESTION] Special `@module name` for classes in root src directory?

rlubke opened this issue · comments

commented

I'm close to getting the documentation the way I'd like to see it generated, thanks to this plugin, however, I've hit a snag with classes that are part of the root (for lack of a better term) directory of the sources. I want these classes to be in the top-level TOC of the index with the modules based on the sub-directories listed below.

Instead, the resulting documentation creates a module named <em>Module</em> and the results are buried away in there.

Is there a special identifier for the top-level module that I'm missing or some trick to accomplish this?

Using version 4.0.3 of the plugin and typedoc 0.17.8.

commented

Thought it might be easier to visualize if you saw what I was seeing. I'd like to have those classes on the left in the TOC of the index and not have that Module rendered at all.