{"id":13549158,"url":"https://github.com/theseer/phpdox","last_synced_at":"2025-05-15T01:10:04.335Z","repository":{"id":41512153,"uuid":"941114","full_name":"theseer/phpdox","owner":"theseer","description":"Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT)","archived":false,"fork":false,"pushed_at":"2023-04-20T13:44:47.000Z","size":5105,"stargazers_count":600,"open_issues_count":51,"forks_count":122,"subscribers_count":25,"default_branch":"master","last_synced_at":"2025-04-13T23:54:00.399Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://phpdox.de","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/theseer.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2010-09-26T21:42:53.000Z","updated_at":"2025-04-02T00:48:14.000Z","dependencies_parsed_at":"2024-06-18T10:45:36.805Z","dependency_job_id":"43306037-7ba1-4984-8fd3-f0e22ff5bd5d","html_url":"https://github.com/theseer/phpdox","commit_stats":{"total_commits":1004,"total_committers":52,"mean_commits":"19.307692307692307","dds":"0.16135458167330674","last_synced_commit":"1aa70b1451932d97b389a359895a2f45ea994997"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theseer%2Fphpdox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theseer%2Fphpdox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theseer%2Fphpdox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theseer%2Fphpdox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/theseer","download_url":"https://codeload.github.com/theseer/phpdox/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254254043,"owners_count":22039792,"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":[],"created_at":"2024-08-01T12:01:18.844Z","updated_at":"2025-05-15T01:09:59.314Z","avatar_url":"https://github.com/theseer.png","language":"PHP","funding_links":[],"categories":["PHP","Table of Contents"],"sub_categories":["Library"],"readme":"phpDox\n======\n\n*phpDox* is a documentation generator for PHP projects.\nThis includes, but is not limited to, API documentation. The main focus is on enriching\nthe generated documentation with additional details like code coverage, complexity information\nand more.\n\n[![Build Status](https://travis-ci.org/theseer/phpdox.svg?branch=master)](https://travis-ci.org/theseer/phpdox)\n[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/theseer/phpdox/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/theseer/phpdox/?branch=master)\n\nRequirements\n------------\n\n- PHP Version 7.1+ (For PHP 5.5+, use phpDox 0.11.2)\n  - ext/dom\n  - ext/xsl\n  - ext/iconv and [libiconv version \u003e= 2.12](http://www.gnu.org/software/libiconv/documentation/libiconv/iconv.1.html)\n- PHPParser [PHP Parser API](https://github.com/nikic/PHP-Parser)\n- [fDOMDocument](http://github.com/theseer/fDOMDocument)\n- [DirectoryScanner](http://github.com/theseer/DirectoryScanner)\n- [fXSL](http://github.com/theseer/fXSL)\n- [PHP_Timer](http://github.com/sebastianbergmann/php-timer)\n\n\nPhar Installation\n-----------------\n\nphpDox is shipping as a selfcontained executable phar archive. You can grab your copy from the\n[releases](https://github.com/theseer/phpdox/releases/latest) section or install using [phive](https://phar.io):\n\n    phive install phpdox\n\nYou can now execute phpdox on the command line:\n\n    tools/phpdox --version\n\nIf everything worked out, you should get an output like this:\n\n    phpDox 0.11.2 - Copyright (C) 2010 - 2018 by Arne Blankerts and Contributors\n\n_Note: Some Linux distributions ship PHP with ext/suhosin and disabled phar execution. To make use of phpDox in such an environment, you need to enable phar execution by adding phar to the executor white list: suhosin.executor.include.whitelist=\"phar\"_\n\n\nComposer Installation\n---------------------\n\nAdditionally, phpDox can be installed via composer:\n\n    composer require --dev theseer/phpdox \n\nYou can now execute phpdox on the command line:\n\n    vendor/bin/phpdox --version\n\nIf everything worked out, you should get an output like this:\n\n    phpDox 0.11.2 - Copyright (C) 2010 - 2018 by Arne Blankerts and Contributors\n\n\nDeveloper Installation\n----------------------\n\nIn case you want to go bleeding edge or hack on the source, you will have to clone this repository.\n\n    git clone git://github.com/theseer/phpdox.git\n    composer install\n\n\nUsage Examples\n--------------\n\nYou can run phpDox like this:\n\n    phpdox --help\n\nAs of version 0.4 phpDox requires an xml configuration file. In case a project you want to generate documentation for does not come with one, you can create it by calling\n\n    phpdox --skel \u003e phpdox.xml.dist\n\n\nSample invocation to parse and generate output based on the default phpdox.xml configuration file\n\n    phpdox\n\nor you can tell `phpdox` what configuration file to use by calling switch `--file` or in short\n\n    phpdox -f path/to/phpdox.xml\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheseer%2Fphpdox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftheseer%2Fphpdox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheseer%2Fphpdox/lists"}