{"id":16210956,"url":"https://github.com/artees/doccover","last_synced_at":"2025-09-04T09:45:03.755Z","repository":{"id":144190254,"uuid":"144423162","full_name":"Artees/DocCover","owner":"Artees","description":"A .NET Core application that calculates the percentage of public members and types in your .NET assembly that have XML comments.","archived":false,"fork":false,"pushed_at":"2018-09-01T20:21:27.000Z","size":32,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-29T17:08:02.128Z","etag":null,"topics":["comments","documentation","xml"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Artees.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":"2018-08-11T22:55:46.000Z","updated_at":"2018-09-01T20:21:28.000Z","dependencies_parsed_at":null,"dependency_job_id":"a451d0e3-cc7f-49a0-8c57-f2972fb9a117","html_url":"https://github.com/Artees/DocCover","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Artees%2FDocCover","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Artees%2FDocCover/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Artees%2FDocCover/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Artees%2FDocCover/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Artees","download_url":"https://codeload.github.com/Artees/DocCover/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247731693,"owners_count":20986706,"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":["comments","documentation","xml"],"created_at":"2024-10-10T10:45:05.498Z","updated_at":"2025-04-07T21:27:15.685Z","avatar_url":"https://github.com/Artees.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DocCover\n[![GitHub release](https://img.shields.io/github/release/Artees/DocCover.svg)](https://github.com/Artees/DocCover/releases)\n[![NuGet](https://img.shields.io/nuget/v/DocCover.svg)](https://www.nuget.org/packages/DocCover/)\n\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\n[![Build Status](https://travis-ci.org/Artees/DocCover.svg?branch=master)](https://travis-ci.org/Artees/DocCover)\n[![codecov](https://codecov.io/gh/Artees/DocCover/branch/master/graph/badge.svg)](https://codecov.io/gh/Artees/DocCover)\n[![CodeFactor](https://www.codefactor.io/repository/github/artees/doccover/badge)](https://www.codefactor.io/repository/github/artees/doccover)\n\nA .NET Core application that calculates the percentage of public members and types in your \n.NET assembly that have XML comments. I just wanted this badge for my repos :3 \n[![Documented](report_example/badge.svg)](https://htmlpreview.github.io/?https://github.com/Artees/DocCover/blob/master/report_example/index.html)  \nIt uses [Shields.io](https://shields.io) to generate a badge.\n\n## Usage\n`dotnet path\\to\\DocCover.dll path\\to\\docs.xml`\n\nCommand line arguments:\n\n| Argument                  \t| Description                                                                                                                                     \t|\n|---------------------------\t|-------------------------------------------------------------------------------------------------------------------------------------------------\t|\n| --help                    \t| Display the help screen.                                                                                                                        \t|\n| --version                 \t| Display version information.                                                                                                                    \t|\n| -x, --xml (pos. 0)        \t| The XML document to be analyzed.                                                                                                                \t|\n| -d, --dll (pos. 1)        \t| The assembly file to be analyzed. If not specified, the path of the XML document will be used.                                                  \t|\n| -o, --outputdir (pos. 2)  \t| The directory where the generated report should be saved.                                                                                       \t|\n| -s, --badgestyle (pos. 3) \t| The style of the generated badge. The following styles are available: plastic, flat, flat-square, for-the-badge, popout, popout-square, social. \t|","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartees%2Fdoccover","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fartees%2Fdoccover","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartees%2Fdoccover/lists"}