{"id":18681296,"url":"https://github.com/psycofdj/coverxygen","last_synced_at":"2025-08-20T18:32:05.096Z","repository":{"id":45795055,"uuid":"65724446","full_name":"psycofdj/coverxygen","owner":"psycofdj","description":"Generate doxygen's documentation coverage report","archived":false,"fork":false,"pushed_at":"2023-06-19T17:48:57.000Z","size":208,"stargazers_count":50,"open_issues_count":4,"forks_count":11,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-12-09T09:39:19.779Z","etag":null,"topics":["coverage","documentation-tool","doxygen"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/psycofdj.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-08-15T10:31:10.000Z","updated_at":"2024-11-15T13:14:55.000Z","dependencies_parsed_at":"2024-06-19T01:36:14.760Z","dependency_job_id":"853b4c47-0e6a-4bd7-9035-b5d7efe06e50","html_url":"https://github.com/psycofdj/coverxygen","commit_stats":{"total_commits":50,"total_committers":9,"mean_commits":5.555555555555555,"dds":"0.33999999999999997","last_synced_commit":"c682c1456b1ef8b115f2b2b7e44eea669aa2eaf8"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/psycofdj%2Fcoverxygen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/psycofdj%2Fcoverxygen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/psycofdj%2Fcoverxygen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/psycofdj%2Fcoverxygen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/psycofdj","download_url":"https://codeload.github.com/psycofdj/coverxygen/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230445926,"owners_count":18227060,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["coverage","documentation-tool","doxygen"],"created_at":"2024-11-07T10:06:49.253Z","updated_at":"2024-12-19T14:06:42.403Z","avatar_url":"https://github.com/psycofdj.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-generate-toc again --\u003e\n**Table of Contents**\n\n- [Coverxygen](#coverxygen)\n- [How to](#how-to)\n    - [Prerequisites](#prerequisites)\n    - [Installation](#installation)\n    - [Configure doxygen](#configure-doxygen)\n    - [Run Coverxygen](#run-coverxygen)\n    - [Run lcov or genhtml](#run-lcov-or-genhtml)\n    - [Results](#results)\n- [Credits](#credits)\n- [Project status](#project-status)\n\n\u003c!-- markdown-toc end --\u003e\n\n# Coverxygen\n\n[![Continuous Integration](https://github.com/psycofdj/coverxygen/actions/workflows/ci.yml/badge.svg)](https://github.com/psycofdj/coverxygen/actions/workflows/ci.yml)\n[![Coverage Status](https://coveralls.io/repos/github/psycofdj/coverxygen/badge.svg?branch=master)](https://coveralls.io/github/psycofdj/coverxygen?branch=master)\n\n# How to\n\nFirst, run doxygen with XML output on your project, Coverxygen will read generated file and produce an lcov compatible output.\nFinally, run `lcov` or `genhtml` to produce the coverage output.\n\nAlternatively, Coverxygen can also calculate the coverage and print a summary table when given the option `--format summary`.\n\n## Prerequisites\n\nCoverxygen relies on doxygen to generate the documentation information.\n```bash\nsudo apt-get install doxygen\n```\n\nAdditionally, if you want to generate coverage reports using lcov, this needs to be installed as well:\n```bash\nsudo apt-get install lcov\n```\n\n## Installation\n\nFrom pip\n\n```bash\npip3 install coverxygen\n```\nFrom PPA Packages\n\nlink : https://launchpad.net/~psycofdj/+archive/ubuntu/coverxygen\n```bash\nsudo add-apt-repository ppa:psycofdj/coverxygen\nsudo apt-get update\nsudo apt-get install python3-coverxygen\n```\n\n## Configure doxygen\n\nTell doxygen to generate an XML version of your doxyfile.cfg configuration\n```\nGENERATE_XML = YES\n```\n\nThen run doxygen\n```bash\ndoxygen \u003cpath_to_your_doxygen.cfg\u003e\n```\n\n## Run Coverxygen\n```bash\npython3 -m coverxygen --xml-dir \u003cpath_to_doxygen_xml_dir\u003e --src-dir \u003cpath_to_root_source_dir\u003e --output doc-coverage.info\n```\n\nFull usage :\n```\nusage: coverxygen [-h] [--version] [--verbose] [--json] [--format FORMAT]\n                  [--prefix PREFIX] [--exclude EXCLUDE] [--include INCLUDE]\n                  [--scope SCOPE] [--kind KIND] --xml-dir XML_DIR --output\n                  OUTPUT --src-dir SRC_DIR\n\nrequired arguments:\n  --xml-dir XML_DIR  path to generated doxygen XML directory\n  --output OUTPUT    destination output file (- for stdout)\n  --src-dir SRC_DIR  root source directory used to match prefix for relative path generated files\n\noptional arguments:\n  -h, --help         show this help message and exit\n  --version          print version and exit\n  --verbose          enabled verbose output\n  --json             (deprecated) same as --format json-legacy\n  --format FORMAT    output file format :\n                     lcov             : lcov compatible format (default)\n                     json-v3          : json format which includes summary information\n                     json-v2          : simpler json format\n                     json-v1          : legacy json format\n                     json             : (deprecated) same as json-v2\n                     json-legacy      : (deprecated) same as json-v1\n                     json-summary     : summary in json format\n                     markdown-summary : ummary in markdown table format\n                     summary          : textual summary table format\n  --prefix PREFIX    keep only file matching given path prefix\n  --exclude EXCLUDE  exclude files whose absolute path matches a regular expression;\n                     this option can be given multiple times\n  --include INCLUDE  include files whose absolute path matches a regular expression\n                     even if they also match an exclude filter (see --exclude) or if they\n                     are not matching the patch prefix (see --prefix);\n                     this option can be given multiple times\n  --scope SCOPE      comma-separated list of item scopes to include :\n                      - public    : public member and global elements\n                      - protected : protected member elements\n                      - private   : private member elements\n                      - all       : all above\n  --kind KIND        comma-separated list of item types to include :\n                      - enum      : enum definitions\n                      - enumvalue : enum value definitions\n                                    Note: a single undocumented enum value will mark\n                                    the containing enum as undocumented\n                      - friend    : friend declarations\n                      - typedef   : type definitions\n                      - variable  : variable definitions\n                      - function  : function definitions\n                      - signal    : Qt signal definitions\n                      - slot      : Qt slot definitions\n                      - class     : class definitions\n                      - struct    : struct definitions\n                      - union     : union definitions\n                      - define    : define definitions\n                      - file      : files\n                      - namespace : namespace definitions\n                      - page      : documentation pages\n                      - all       : all above\n\n```\n\n## Run lcov or genhtml\n\nlcov can be used to generate a simple console output based on documented lines :\n```\nlcov --summary doc-coverage.info\n```\n\nMore interesting, produce a html-browsable coverage detail :\n```bash\ngenhtml --no-function-coverage --no-branch-coverage doc-coverage.info -o .\n# browse results in index.html\n```\n\n## Results\n\n### `summary` Format\n\n```\nClasses    :  90.5% (38/42)\nDefines    :   0.0% (0/2)\nEnum Values:  12.3% (8/65)\nEnums      :  75.0% (3/4)\nFiles      :   8.3% (2/24)\nFunctions  :  64.8% (175/270)\nNamespaces :  75.0% (6/8)\nPages      : 100.0% (7/7)\nSignals    :  83.3% (5/6)\nSlots      :  28.6% (2/7)\nStructs    :  80.0% (4/5)\nTypedefs   :  39.1% (9/23)\nVariables  :  20.0% (8/40)\n-----------------------------------\nTotal      :  53.1% (267/503)\n```\n\n### lcov\n\nOverview\n\n![Summary](./docs/coverage-summary.png)\n\nDetails\n\n![Details](./docs/coverage-details.png)\n\n# Credits\nSpecial thanks to Alvaro Lopez Ortega \u003c[alvaro@gnu.org](mailto:alvaro@gnu.org)\u003e who found a smart and efficient solution to retrieve doxygen informations from the generated xml.\n\nYou can find his work at [alobbs/doxy-coverage](https://github.com/alobbs/doxy-coverage)\n\n## Hall of Fame\n\n- [j-ulrich](https://github.com/j-ulrich) for his many contributions\n- [antoniovazquezblanco](https://github.com/antoniovazquezblanco) for his many contributions\n\n\n# Project status\n\nUnstable but usable.\n[![PyPI version](https://badge.fury.io/py/coverxygen.svg)](https://badge.fury.io/py/coverxygen)\n\n\n\u003c!--  LocalWords:  doxyfile cfg xml alobbs doxy --\u003e\n\u003c!-- Local Variables: --\u003e\n\u003c!-- ispell-local-dictionary: \"american\" --\u003e\n\u003c!-- End: --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpsycofdj%2Fcoverxygen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpsycofdj%2Fcoverxygen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpsycofdj%2Fcoverxygen/lists"}