Phuedx has uploaded a new change for review. https://gerrit.wikimedia.org/r/214324
Change subject: Generate PHP docs with Composer ...................................................................... Generate PHP docs with Composer Running `composer test` failed because of the PHPDocumentor fixtures included by the grunt-phpdocumentor npm package... Since Composer is now responsible for running PHP-specific commands, use it to generate PHP docs as well. Since there's no longer any PHP in the `node_modules` directory, it no longer has to be special-cased the PHP-specific tooling. Also, update `phpdoc.xml` to reflect the PHPDocumentor defaults [0]. [0] http://phpdoc.org/docs/latest/references/configuration.html Change-Id: I12ca5c2d32a0d0accd095adfc135ec18e2ebd7ab --- M Makefile M composer.json M package.json M phpdoc.xml 4 files changed, 14 insertions(+), 11 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/MobileFrontend refs/changes/24/214324/1 diff --git a/Makefile b/Makefile index 0e9cad2..229684c 100644 --- a/Makefile +++ b/Makefile @@ -27,11 +27,11 @@ jsduck: nodecheck gems ## Build the JavaScript documentation @grunt docs --MW_INSTALL_PATH=${MW_INSTALL_PATH} -phpdoc: nodecheck ## Build the PHP documentation +phpdoc: ## Build the PHP documentation mkdir -p docs rm -rf docs/php mkdir -p docs/php/log - @php node_modules/grunt-phpdocumentor/bin/phpDocumentor.phar -c phpdoc.xml + @composer docs docs: jsduck phpdoc ## Build the styleguide, JavaScript, and PHP documentation diff --git a/composer.json b/composer.json index d3201eb..b221236 100644 --- a/composer.json +++ b/composer.json @@ -1,12 +1,16 @@ { "require-dev": { "jakub-onderka/php-parallel-lint": "0.8.*", - "mediawiki/mediawiki-codesniffer": "0.1.0" + "mediawiki/mediawiki-codesniffer": "0.1.0", + "phpdocumentor/phpdocumentor": "^2.8" }, "scripts": { "test": [ "parallel-lint . --exclude vendor", "phpcs --standard=vendor/mediawiki/mediawiki-codesniffer/MediaWiki --extensions=php,php5,inc --ignore=vendor -p ." + ], + "docs": [ + "phpdoc" ] } } diff --git a/package.json b/package.json index 8f9862e..d92c15f 100644 --- a/package.json +++ b/package.json @@ -11,7 +11,6 @@ }, "dependencies": { "grunt": "0.4.5", - "grunt-phpdocumentor": "~0.4.1", "jshint": ">=1.1.0", "jscs": ">=1.11.3", "jsdoc": "<=3.3.0", diff --git a/phpdoc.xml b/phpdoc.xml index 6d98b9a..2463147 100644 --- a/phpdoc.xml +++ b/phpdoc.xml @@ -3,13 +3,14 @@ <title>Extension:MobileFrontend</title> <parser> <target>docs/php</target> - <markers> - <item>TODO</item> - <item>FIXME</item> - </markers> + <extensions> + <extension>php</extension> + <extension>php5</extension> + <extension>inc</extension> + </extensions> </parser> <transformer> - <target>docs/php</target> + <target>docs/php/</target> </transformer> <logging> <level>debug</level> @@ -19,9 +20,8 @@ </paths> </logging> <files> - <directory>./</directory> + <directory>.</directory> <ignore>vendor/*</ignore> <ignore>tests/*</ignore> - <ignore>node_modules/*</ignore> </files> </phpdoc> -- To view, visit https://gerrit.wikimedia.org/r/214324 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I12ca5c2d32a0d0accd095adfc135ec18e2ebd7ab Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/MobileFrontend Gerrit-Branch: master Gerrit-Owner: Phuedx <[email protected]> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
