[BUG] Interface will not show as documented
See original GitHub issueOverview of the issue
Coverage report does not show documented interface.
Operating System, Node.js, npm, compodoc version(s)
Mac OS 10.12.5, Node v8.11.1, npm 6.2.0, Angular CLI 6.0.8, compodoc 1.1.3
Angular configuration, a package.json
file in the root folder
I can not reveal the package.json (work related etc). I am using a CLI-generated workspace, modified with the nx workspace schematics.
Compodoc installed globally or locally ?
Locally
If possible sourcecode of the file where it breaks
No break in particular. The interface just shows up in red in the coverage report. No amount of fiddling with the JSDoc alters this.
If possible your terminal logs before the error
Again, not really an “error” in this manner. The interface just will not show as documented in the coverage report.
Motivation for or Use Case
Can’t achieve 100% coverage. (It’s not just this interface, but this one interface is a shining example; it is fully documented, exactly as other interfaces elsewhere in the project, but this one won’t show as doc’d).
Reproduce the error
In file auth-feature.reducers.ts, I have an interface, doc’d this way:
/**
- Interface for [etc…]
- @interface AuthFeatureData
- @export AuthFeatureData */ export interface AuthFeatureData { … }
Related issues
All in all, it looks like all my ngrx files will not doc. I have classes (e.g. Actions) that will not show as doc’d no matter what I try. There’s a couple of other items that have the same problem, but I suspect if I can focus on this one (since it is overt), I can probably see what I’m doing wrong (or what is going wrong) elsewhere.
Suggest a Fix
How do I get these showing as doc’d?
Issue Analytics
- State:
- Created 5 years ago
- Comments:12 (2 by maintainers)
Top GitHub Comments
FYI I’ll be picking this back up in earnest. I’m using compodoc on a pretty weighty project.
I’ll see if I can gen something today.