Question 1

ApiGen vs phpDocumentor: which is better for PHP 8.3?

Accepted Answer

ApiGen is more up-to-date with PHP 8.3 features like typed class constants and comprehensive phpDoc support, while phpDocumentor is older but has a larger ecosystem. Choose ApiGen for modern PHP projects, but phpDocumentor if you need extensive plugins.

Question 2

How to customize ApiGen output themes?

Accepted Answer

Set themeDir in apigen.neon to a custom directory with Latte templates, as ApiGen uses Latte for rendering. There are no built-in theme options, so you'll need to create or modify templates manually.

Question 3

Does ApiGen work with Docker in CI/CD pipelines?

Accepted Answer

Yes, the apigen/apigen Docker image allows easy integration by mounting volumes and specifying commands. This makes it suitable for automated documentation generation in pipelines without local PHP setup.

Question 4

Can ApiGen handle PHP 8.2 readonly classes?

Accepted Answer

Yes, ApiGen fully supports PHP 8.2 features including readonly classes, DNF types, and constants in traits, as listed in its feature support from PHP 5.4 onward.

Question 5

How to exclude internal tags in ApiGen?

Accepted Answer

Use the excludeTagged parameter in apigen.neon with tags like 'internal' to filter out class-likes and members marked with those phpDoc tags, keeping documentation focused on public APIs.

Question 6

What's the memory usage for large projects?

Accepted Answer

Default memoryLimit is 512M, configurable via CLI or config. For very large codebases, you might need to increase this, as parallel processing can be memory-intensive depending on workerCount.

APIGen

What is APIGen?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions