{"id":24510484,"url":"https://github.com/polarphp/apigen","last_synced_at":"2026-06-08T16:05:08.606Z","repository":{"id":217801676,"uuid":"171182826","full_name":"polarphp/ApiGen","owner":"polarphp","description":"PHP 7.1 ready Smart and Simple Documentation for your PHP project ","archived":false,"fork":false,"pushed_at":"2019-04-11T22:54:49.000Z","size":7154,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-15T09:41:26.593Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://apigen.github.io/ApiGen/","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/polarphp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2019-02-17T23:06:22.000Z","updated_at":"2019-07-16T02:20:43.000Z","dependencies_parsed_at":null,"dependency_job_id":"1ca29c70-0e18-42b7-8bb5-28bf11454669","html_url":"https://github.com/polarphp/ApiGen","commit_stats":null,"previous_names":["polarphp/apigen"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/polarphp/ApiGen","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polarphp%2FApiGen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polarphp%2FApiGen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polarphp%2FApiGen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polarphp%2FApiGen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/polarphp","download_url":"https://codeload.github.com/polarphp/ApiGen/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/polarphp%2FApiGen/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34069506,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-08T02:00:07.615Z","response_time":111,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2025-01-22T00:29:15.034Z","updated_at":"2026-06-08T16:05:08.586Z","avatar_url":"https://github.com/polarphp.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Smart and Readable Documentation for your PHP project\n\n[![Build Status](https://img.shields.io/travis/ApiGen/ApiGen/master.svg?style=flat-square)](https://travis-ci.org/ApiGen/ApiGen)\n[![Coverage Status](https://img.shields.io/coveralls/ApiGen/ApiGen/master.svg?style=flat-square)](https://coveralls.io/github/ApiGen/ApiGen?branch=master)\n[![Downloads](https://img.shields.io/packagist/dt/apigen/apigen.svg?style=flat-square)](https://packagist.org/packages/apigen/apigen/stats)\n[![Latest stable](https://img.shields.io/packagist/vpre/apigen/apigen.svg?style=flat-square)](https://packagist.org/packages/apigen/apigen)\n\nApiGen is the simplest, the easiest to use and the most modern api doc generator. It is **all PHP 7.1 features ready**\neasy to extend with own Finder, Annotation Subscriber or even Generator.\n\nJust look at [**ApiGen API**](https://apigen.github.io/ApiGen):\n\n![ApiGen Preview](docs/preview.png)\n\n## Your Help is Needed to Finish 5.x Release  \n\n:heart: We need your help to test new version of ApiGen.\n\n### How to install it?\n\nAdd to your `composer.json`:\n\n```json\n{\n    \"require\": {\n        \"apigen/apigen\": \"dev-master\",\n        \"roave/better-reflection\": \"dev-master#c87d856\"\n    }\n}\n```\n\nthen update:\n\n```bash\ncomposer update\n```\n\nTest it, report issues or send PRs.\n\n :skull:  **Version 4.x is not supported**, since there was huge change of Reflection library and the code was almost completely rewritten.\n\n\n## Built on Shoulders of Giants\n\n- PHP 7.1+\n- [nikic/PHP-Parser](https://github.com/nikic/PHP-Parser)\n- [Roave/BetterReflection](https://github.com/Roave/BetterReflection)\n- [phpDocumentor/TypeResolver](https://github.com/phpDocumentor/TypeResolver)\n- [phpDocumentor/ReflectionDocBlock](https://github.com/phpDocumentor/ReflectionDocBlock)\n\n\n## Install\n\n```bash\ncomposer require apigen/apigen --dev\n```\n\n\n## Usage\n\nGenerate API docs by passing single source and destination options:\n\n```bash\nvendor/bin/apigen generate src --destination docs\n```\n\nOr generate API docs for multiple directories:\n\n```bash\nvendor/bin/apigen generate src tests --destination docs\n```\n\n\n## Configuration\n\nBelow is a minimal example configuration. Save it as a `apigen.yml` file in\nthe root of your project:\n\n```yaml\nparameters:\n    visibilityLevels: [public, protected] # array\n    annotationGroups: [todo, deprecated] # array\n    title: \"ApiGen Docs\" # string\n    baseUrl: \"http://apigen.org/api\" # string\n    overwrite: false # bool\n```\n\n\n## What Annotations Have Extra Care?\n\n### `@see`, `@covers`, `@uses`\n\nReference to Class, Function, Property, Method etc. element.\n\n**In Code**\n\n```php\n/**\n * @see SomeClass\n * @see SomeClass::$propety\n * @see SomeClass::someFunction()\n */\n```\n\n**Generated**\n\n```html\n@see \u003ca href=\"class-SomeClass.html\"\u003eSomeClass\u003c/a\u003e\n@see \u003ca href=\"class-SomeClass.html#$someProperty\"\u003eSomeClass::$property\u003c/a\u003e\n@see \u003ca href=\"class-SomeClass.html#_someFunction\"\u003eSomeClass::someFunction()\u003c/a\u003e\n```\n\n---\n\n### `@link`\n\nA website url.\n\n**In Code**\n\n```php\n/**\n * This is already mentioned on Wiki.\n * @link https://en.wikipedia.org/wiki/United_we_stand,_divided_we_fall Click to see a cool quote  \n */\n```\n\n**Generated**\n\n```html\nThis is already mentioned on Wiki.\n@link \u003ca href=\"https://en.wikipedia.org/wiki/United_we_stand,_divided_we_fall\"\u003eClick to see a cool quote\u003c/a\u003e \n```\n\n### `@internal` \n\nAssociated element is internal, so ApiGen hides it.\n\n\n## Themes\n\nTo enable a custom theme just provide `themeDirectory` configuration option in your `apigen.yml`:\n\n```yaml\nparameters:\n    themeDirectory: path/to/theme # path to theme's config file\n```\n\n## Contributing\n\nRules are simple:\n\n- **new feature needs tests**\n- **all tests must pass**\n    ```bash\n    composer complete-check\n    ```\n- **1 feature per PR**\n\nWe would be happy to merge your feature then.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolarphp%2Fapigen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpolarphp%2Fapigen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolarphp%2Fapigen/lists"}