Typedoc: have doc coverage

Created on 6 Jul 2019  路  2Comments  路  Source: TypeStrong/typedoc

Problem

https://compodoc.app/ (documentation coverage)

Suggested Solution

fileCommented (match "@" maybe) / all files

enhancement plugin idea

Most helpful comment

I was sure this had been brought up before, but I can't seem to find the issue....

This would be a neat feature to have, but just matching on @ won't be very helpful. Ideally this feature should report doc comments / documented members for each file. (Even better check for @param & such)

I think it should be fairly straightforward, it would probably be best to implement it as a plugin first so that it can be disabled to avoid a performance hit for those not interested in the information it reports.

All 2 comments

I was sure this had been brought up before, but I can't seem to find the issue....

This would be a neat feature to have, but just matching on @ won't be very helpful. Ideally this feature should report doc comments / documented members for each file. (Even better check for @param & such)

I think it should be fairly straightforward, it would probably be best to implement it as a plugin first so that it can be disabled to avoid a performance hit for those not interested in the information it reports.

Closing this as it should really be implemented as a plugin first, and should probably remain as a plugin so that we avoid the performance hit of calculating this. If you (or anyone) implements this, please post here to promote it :)

Was this page helpful?
0 / 5 - 0 ratings