{"id":21647882,"url":"https://github.com/markknol/haxe-doc-stats","last_synced_at":"2026-02-06T11:36:18.166Z","repository":{"id":69819663,"uuid":"61664824","full_name":"markknol/haxe-doc-stats","owner":"markknol","description":"Are we documented yet? Code documentation coverage metrics for Haxe","archived":false,"fork":false,"pushed_at":"2020-06-16T10:22:13.000Z","size":6435,"stargazers_count":17,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-06-07T09:44:19.810Z","etag":null,"topics":["documentation","documentation-coverage","haxe","metrics","statistics","tool"],"latest_commit_sha":null,"homepage":"","language":"Haxe","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/markknol.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-06-21T20:26:14.000Z","updated_at":"2022-06-12T14:14:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"2ed6d9b0-2274-4070-b7c1-ef8ebaa71220","html_url":"https://github.com/markknol/haxe-doc-stats","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/markknol/haxe-doc-stats","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markknol%2Fhaxe-doc-stats","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markknol%2Fhaxe-doc-stats/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markknol%2Fhaxe-doc-stats/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markknol%2Fhaxe-doc-stats/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/markknol","download_url":"https://codeload.github.com/markknol/haxe-doc-stats/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markknol%2Fhaxe-doc-stats/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29159602,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-06T07:18:23.844Z","status":"ssl_error","status_checked_at":"2026-02-06T07:13:32.659Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["documentation","documentation-coverage","haxe","metrics","statistics","tool"],"created_at":"2024-11-25T06:52:09.940Z","updated_at":"2026-02-06T11:36:18.096Z","avatar_url":"https://github.com/markknol.png","language":"Haxe","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Haxe doc stats\n\u003e ### Are we documented yet?\n\nDisplay how much your Haxe project is documented. \nThis generator uses Neko to generate a static page with stats about your Haxe project code documentation coverage. The tool is created to get more information about the Haxe Standard Library API documentation, but can be used for any project.\n\n- Displays documentation amounts for types and its members (global and detailed per package)\n- Packages can be expanded to see what is undocumented\n\n## Preview\n\nTo see the stats of the Haxe Standard Library: \u003chttp://haxe.stroep.nl/api-stats/3.3/\u003e\n\n![api-stats](https://cloud.githubusercontent.com/assets/576184/16715856/554cec7e-46ec-11e6-804f-5ac23f174c40.gif)\n\n## How to use\nAdd `-xml xml/output.xml` to your project build configuration (hxml or compilation flags). \nThis will produce a .xml file in your project with documentation info which you'll need for this tool.\n\nPut it in a folder and run the following command:\n```\nneko DocStats.n xml/\n```\nThis will produce a `index.html` file in the _xml/_ folder. \n\n---\n\nFor more specific use, there are more parameters:\n```\nneko DocStats.n arg0 arg1 arg2 arg3\n  [arg0] path to xml directory. default: 'xml/'\n  [arg1] path to output file. default: 'xml/index.html'\n  [arg2] path to template html-file. default: 'layout.html' \n  [arg3] path to log-file. default: 'xml/log.txt\n```\n\n## Details\n\nThese are the rules/definitions used by this statistics:\n\n * \"Types\" can be classes, typedefs, abstracts, enums, interfaces.\n * \"Members\" are fields, functions, statics, enum constructors.\n * Everything that is private/override or has metadata `@:dox(hide)` or `@:noCompletion` gets skipped.\n * The quality of the documentation is not measured.\n * The colors work like this:\n \n   * higher than 75% is good\n   * lower than 10% is bad\n\n## More\n\n* The more documentation your project has, the better.\n* Use [Dox](https://github.com/HaxeFoundation/dox) to generate API documentation for your project.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkknol%2Fhaxe-doc-stats","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarkknol%2Fhaxe-doc-stats","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkknol%2Fhaxe-doc-stats/lists"}