# phpDocumentor/phpDocumentor

Documentation Generator for PHP

Repository: https://github.com/phpDocumentor/phpDocumentor
Canonical: https://ross.abutalabs.com/products/phpdocumentor
Homepage: https://www.phpdoc.org
Language: PHP
License: MIT
License Family: permissive
Topics: hacktoberfest, phpdocumentor, graphviz, docblocks, docblock, php
Last push: 2026-08-24T02:37:55+00:00

## Health v2 (maintenance only)
Score: 89/100 (v2, computed 2026-09-03T02:39:23.370411+00:00)
- activity 99, release rhythm 71, longevity 100
- inputs: {"age_days": 5901, "days_push": 10, "days_rel": 112, "gap_med": 54, "n_releases_24m": 8}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 4346, forks 648 (observed 2026-08-28T04:08:46.180355+00:00)

## What it is
phpDocumentor is the de-facto documentation generator for PHP projects, producing API documentation from source code and DocBlock comments. It also generates UML class diagrams and supports Markdown and RestructuredText guides with API integration.

## Use cases
- generate api documentation for a php project
- document php code from docblocks
- create uml class diagrams from php source
- integrate documentation generation into ci pipeline
- write project guides in markdown alongside api docs
- publish searchable offline php api docs

## When to choose
- you maintain a PHP library or application and want standard PHPDoc-based API docs
- you need UML diagrams and markup guides alongside API documentation
- you want CI-friendly docs generation via Docker, PHAR, or GitHub Action

## When to avoid
- your project is not written in PHP
- you need runtime or user-facing documentation rather than API reference
- you want a lightweight docblock linter only rather than a full generator

## Facets
- artifact type: application
- maturity: stable
- function: documentation, parser, static-site-generator, cli
- domain: documentation, developer-tools, apis
- platform: php, cli, cross-platform
- tags: api-docs, docblocks, phpdoc, uml-diagrams, markdown, restructuredtext, php, docker

## Member repositories
- phpDocumentor/phpDocumentor (main) score 89

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:08:46.180355+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T18:21:34.815537+00:00, confidence not recorded.
  - readme: https://github.com/phpDocumentor/phpDocumentor (fetched 2026-08-28T04:08:46.180355+00:00, sha 8b84fa445dd5)
  - homepage: https://www.phpdoc.org (fetched 2026-08-29T09:10:35.193943+00:00, sha 0f8a365da6c3)
  - site_page: https://docs.phpdoc.org (fetched 2026-08-29T09:10:35.197169+00:00, sha c25757970a87)
  - site_page: https://docs.phpdoc.org/3.0 (fetched 2026-08-29T09:10:35.199255+00:00, sha c17691063843)
  - site_page: https://docs.phpdoc.org/guide/getting-started/index.html (fetched 2026-08-29T09:10:35.201230+00:00, sha bca1d33db56d)
- Data as of 2026-08-30T08:39:29.467469+00:00.