19

I wanted to ask if there are any features (or add-ons) for Doxygen to measure the documentation coverage via command line. I already know that I can set up Doxygen to write undocumented elements as warnings into a log file, but to fully evaluate the documentation coverage from that, I'd need to write my own warning log parser. Was something like this done already or is there an even easier way I couldn't find? Is there any add-on I could check out for this? Thank you.

user2455387
  • 191
  • 1
  • 3
  • You want an output that says `95% of all functions are documentes`. Did i get that right? – kuga Apr 07 '15 at 11:22

2 Answers2

4

I don't know anything that can give documentation coverage for doxygen, but a quick search gives 2 interesting results : https://github.com/alobbs/doxy-coverage (require xml output for doxygen) and http://jessevdk.github.io/cldoc/ (alternative for c++ projects?)

sebbu
  • 126
  • 1
  • 6
2

There is coverxygen which is using the same idea as alobbs/doxy-coverage (uses xml output of Doxygen) but provides more options (for example, filter by access specifier).

Disclaimer: I am contributing to that project.

Ignitor
  • 2,907
  • 33
  • 50
  • +1 for a CLI solution and a program outputting JSON and YAML, making possible to parse that. I don't understand why it's score is zero, is it because the program is licensed under GPLv3? – Akib Azmain Turja Jan 01 '21 at 09:14