question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[BUG] Interface will not show as documented

See original GitHub issue
Overview 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:closed
  • Created 5 years ago
  • Comments:12 (2 by maintainers)

github_iconTop GitHub Comments

2reactions
tcozcommented, Jul 18, 2019

FYI I’ll be picking this back up in earnest. I’m using compodoc on a pretty weighty project.

2reactions
tcozcommented, May 28, 2019

I’ll see if I can gen something today.

Read more comments on GitHub >

github_iconTop Results From Across the Web

vba - Bug when using interfaces on larger projects
When option 1 is not working, deactivating all Implements statements in the entire project using the Find/Replace window, then compiling and ...
Read more >
Cisco Bug: CSCvw16861 - Clients interfaces with shared MAC ...
SISF has a rule which binds 1 MAC address to 1 IPV4 IP address, so the device tracking database will not show an...
Read more >
QuickPIP - Documentation - Troubleshooting - RaceRender
This occurs when the Video For Windows interface is being used to decode the AVI file, and therefore may not apply to all...
Read more >
Diagnosing and resolving bugs in your running app
Inspect your running app to isolate bugs, locate crashes, identify excess system resource usage, visualize memory bugs, and investigate view layout problems.
Read more >
Throw TypeError when null is specified to non-nullable ...
argument of non-nullable interface type, we should throw TypeError as per WebIDL spec, but the current binding generator does not raise
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found