- Notifications
You must be signed in to change notification settings - Fork309
PHP 7.1 ready Smart and Simple Documentation for your PHP project
License
NotificationsYou must be signed in to change notification settings
ApiGen/ApiGen
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
ApiGen is easy to use and modern API doc generatorsupporting all PHP 8.3 features.
- phpDoc
- PHP 8.3
- PHP 8.2
- PHP 8.1
- PHP 8.0
- PHP 7.4
- PHP 7.2
- PHP 7.1
- PHP 7.0
- PHP 5.6
- PHP 5.4
ApiGen is available asapigen/apigen Docker image which you can directly use.
docker run --rm --interactive --tty --volume"$PWD:$PWD" --workdir"$PWD" \ apigen/apigen:edge \ src --output docs
This will install ApiGen phar binary totools/apigen.
mkdir -p toolscurl -L https://github.com/ApiGen/ApiGen/releases/latest/download/apigen.phar -o tools/apigenchmod +x tools/apigentools/apigen src --output docs
This will install ApiGen totools/apigen directory with executable entry point available intools/apigen/bin/apigen.
composer create-project --no-dev apigen/apigen:^7.0@alpha tools/apigentools/apigen/bin/apigen src --output docs
Generate API docs by passing source directories and destination option:
apigen src --output docs
ApiGen can be configured withapigen.neon configuration file.
parameters:# string[], passed as arguments in CLI, e.g. ['src']paths: []# string[], --include in CLI, included files mask, e.g. ['*.php']include: ['*.php']# string[], --exclude in CLI, excluded files mask, e.g. ['tests/**']exclude: []# bool, should protected members be excluded?excludeProtected:false# bool, should private members be excluded?excludePrivate:true# string[], list of tags used for excluding class-likes and membersexcludeTagged: ['internal']# string, --output in CLIoutputDir:'%workingDir%/api'# string | null, --theme in CLIthemeDir:null# string, --title in CLItitle:'API Documentation'# string, --base-url in CLIbaseUrl:''# int, --workers in CLI, number of processes that will be forked for parallel renderingworkerCount:8# string, --memory-limit in CLImemoryLimit:'512M'
About
PHP 7.1 ready Smart and Simple Documentation for your PHP project
Topics
Resources
License
Stars
Watchers
Forks
Packages0
No packages published