PHP 7.1 ready Smart and Simple Documentation for your PHP project
OTHER License
Bot releases are visible (Hide)
pcntl
extensionPublished by JanTvrdik over 1 year ago
Published by JanTvrdik over 1 year ago
Published by github-actions[bot] about 2 years ago
Published by github-actions[bot] about 2 years ago
Published by JanTvrdik over 2 years ago
Rewritten to be based on nikic/php-parser and phpstan/phpdoc-parser with full support of PHP 8.1 features.
ApiGen is available as apigen/apigen Docker image which you can directly use.
docker run --rm --interactive --tty --volume "$PWD:$PWD" --workdir "$PWD" \
apigen/apigen \
src --output docs
This will install ApiGen phar binary to tools/apigen
.
mkdir -p tools
curl -L https://github.com/ApiGen/ApiGen/releases/download/v7.0.0-alpha/apigen.phar -o tools/apigen
chmod +x tools/apigen
tools/apigen src --output docs
This will install ApiGen to tools/apigen
directory with executable entry point available in tools/apigen/bin/apigen
.
composer create-project --no-dev apigen/apigen:^7.0@alpha tools/apigen
tools/apigen/bin/apigen src --output docs
Published by TomasVotruba about 7 years ago
If you are interested in ApiGen behind-scene @tomasvotruba wrote a post about ApiGen 5 revival process: https://www.tomasvotruba.cz/blog/2017/09/04/how-apigen-survived-its-own-death/
@vlastavesely added as a co-maintainer, thanks to his great additions to the project 👏
#971 Added resolving parent classes, Thanks to @vlastavesely
#987 Improve parsing by BetterReflection by Caching, make use of https://github.com/Roave/BetterReflection/pull/312; also decouple BetterReflection
subpackage and turn static to DI
__CLASS__
parsing, see https://github.com/Roave/BetterReflection/pull/298, Thanks to @vlastaveselyFull diff: https://github.com/ApiGen/ApiGen/compare/v5.0.0-RC4...v5.0.0-RC5
Published by TomasVotruba about 7 years ago
Full diff: https://github.com/ApiGen/ApiGen/compare/v5.0.0-RC3...v5.0.0-RC4
Published by TomasVotruba over 7 years ago
Huge thanks to @vlastavesely for dozens of PR to this release!
Your work is pushing this repository fast forward.
FileLocator
; Thanks to @vlastavesely
vendor/bin/apigen generate src/Directory src/SomeClass.php --destination /api
Full diff: https://github.com/ApiGen/ApiGen/compare/v5.0.0-RC2...v5.0.0-RC3
Published by TomasVotruba over 7 years ago
--version
call in CLI; Thanks to @brunoaugustoTraitMethodReflection::isDeprecated()
; Thanks to @vlastaveselyExceptionGenerator
+ separation from classes in NamespaceGenerator
; Thanks to @vlastaveselyNamespaceGenerator
StepCounter
improvements; Thanks to @vlastaveselycomposer create-project ...
and composer global require ...
command and added tests for them; Thanks to @brunoaugusto and @nelson6e65Thank you all guys for great work. I'm very happy to see such activity around this project! ❤️
Full diff: https://github.com/ApiGen/ApiGen/compare/v5.0.0-RC1...v5.0.0-RC2
Published by TomasVotruba over 7 years ago
Annotation
packageElement
packageModularConfiguration
packageReflection
packageStringRouting
package.editorconfig
to the projectstatic
type@link bitcoin:address
theme
option to load theme from directoryandrewsville/php-token-reflection
to roave/better-reflection
5.4
to 7.1
Nette\DI
to Symfony\DependencyInjection due to Symfony 3.3 new features and PSR-11
PSR-2
compatibleThemeDefault
and ThemeBootstrap
merged to one local theme, with support of Bootstrap 3@internal
annotation cannot be ignored nowClass<Generator,Reflection>
split to Class
, Trait
and Interface
with own type-specific methodsSourceCodeGenerator
dropped and moved to particular reflection generators (ClassGenerator...)generate
command throwing an error@internal
would be documented$this
as return type hint__DIR__
constant parsing::class
parsing--main
option dropped--charset
CLI option has been dropped (expecting UTF-8
now by default)--skip-doc-path
CLI option has ben dropped--template-config
and --template-theme
dropped--exclude
and --extensions
options dropped (use FinderInterface
implementation instead)Tree
generator droppedException
element droppedFull diff: https://github.com/ApiGen/ApiGen/compare/v4.1.2...v5.0.0-RC1
Published by TomasVotruba over 7 years ago
phar
#564Full diff: https://github.com/ApiGen/ApiGen/compare/v4.0.0...v4.0.1
Published by TomasVotruba over 7 years ago
Full diff: https://github.com/ApiGen/ApiGen/compare/v4.1.0...v4.1.1
Published by jadb almost 9 years ago
Minor fixes
Full diff: https://github.com/ApiGen/ApiGen/compare/v4.1.1...v4.1.2
Published by TomasVotruba over 9 years ago
--config
now supports YAML format, thanks to @trong--source
option now accepts single files--annotation-groups
options added, to generate pages with single annotation (e.g. for todo: --annotation-groups=todo
)
--todo --deprecated
(only these two)--annotation-groups todo,deprecated
--annotation-groups event,api
--annotation-groups
has no items, info message is displayed--source-code
options should be --no-source-code
, thanks to @yoosefiapigen.services.neon
removed, thanks to @ramseyFull diff: https://github.com/apigen/apigen/compare/v4.0.1...v4.1.0
Published by TomasVotruba almost 10 years ago
Version 3.0
was skipped, because master branch had 3.0-dev
alias with code
base similar to 2.8. Since then there were many BC breaks, thus major version was bumped to 4.0
.
This release closes refactoring of version 2.8. Its aim was to improve code base, provide fairly high code coverage (from 0 % in 2.8) to improve further development and close old pull-requests. Now it's at 84 %, which really makes changes easier.
Saying that, next version will focus on:
php
is now off by default, turn it on by --php
autocomplete
option dropped - to much detailed was use-non-friendlyFull diff: https://github.com/apigen/apigen/compare/v4.0.0-RC5...v4.0.0
Default command generate
added:
Before:
apigen -s source -d destination
After:
apigen generate -s source -d destination
New command self-update
added, to upgrade .phar
file.
Before:
manual update
After:
apigen self-update
Bool options for arguments passed via CLI are off when absent, on when
present.
Before:
... --tree yes # tree => true
... --tree no # tree => false
After:
... --tree # tree => true
... # tree => false
Options with values for arguments passed via CLI now accept multiple formats:
Before:
... --access-levels public --access-levels protected
After:
... --access-levels public,protected
or
... --access-levels="public,protected"
or
... --access-levels public --access-levels protected
Some CLI options were dropped. To see what the available ones are, just run apigen generate --help
.
--skip-doc-prefix
was dropped, use --skip-doc-path
instead--allowed-html
was dropped--autocomplete
was dropped; autocomplete now works for classes, constants and functions by default--report
; use Php_CodeSniffer for any custom checkstyle--wipeout
; now wipes out everytime--progressbar
; now always present--colors
; now always colors--update-check
; update manually by apigen self-update
(new version is released every ~ 2 months)Some CLI options were renamed and reversed.
--source-code
was off by default, now it on by default; to turn it off, add --no-source-code
Published by TomasVotruba almost 10 years ago
skipDocPrefix
as confusing, use skipDocPath
as regular expression standard [BC break]Full diff: https://github.com/apigen/apigen/compare/v4.0.0-RC4...v4.0.0-RC5
Published by TomasVotruba almost 10 years ago
Full diff: https://github.com/apigen/apigen/compare/v4.0.0-RC3...v4.0.0-RC4
Published by TomasVotruba about 10 years ago
Full diff: https://github.com/apigen/apigen/compare/v4.0.0-RC2...v4.0.0-RC3
Published by TomasVotruba about 10 years ago
highlightAndAddLineNumbers()
decoupled from highlight()
method bool paramFull diff: https://github.com/apigen/apigen/compare/v4.0.0-RC1...v4.0.0-RC2