gomoob / grunt-phpdocumentor Goto Github PK
View Code? Open in Web Editor NEWRuns the PHPDocumentor documentation generator tool.
License: MIT License
Runs the PHPDocumentor documentation generator tool.
License: MIT License
The following values have to be tested :
As soon as it is there, one can provide feedback very easily.
Create a tag 'v0.3.0' and publish it to npm registry.
I'm using this in conjunction with a translation module, and the documenter is picking up the php files from that library, which isn't great.
tried to add an option for ignore, but it doesn't work.
Using the example in the documentation, directory, phar and target configuration not working.
The correct configuration is:
phpdocumentor: {
dist: {
options: {
directory : './libs',
phar: null
}
}
}
or modify code to detect both configurations
Is there a way that the --cache-folder parameter can be set from within the gruntfile?
As its explained in the Grunt documentation Grunt options a plugin should support the following configuration possibilities :
Implement a unit test to test each of those 3 possibilities.
This issue is related to the the pull request 9 and to the issue 8 reported by @mostofreddy.
This package still requires Grunt 0.4 which is quite old and issues warnings when using Grunt 1.0.
Would it possible to update the dependency?
I've been using it with Grunt 1.0 for quite some time and it seems to be totally compatible.
Version 0.3.0 is not available to download via npmjs.
Version 0.1.0 returns error:
File: [no files]
phpdoc --target= --directory=>> Exited with code: 1.
Error: Command failed:
[InvalidArgumentException]
Either an empty path or root was given:
project:run [-t|--target[="..."]] [-f|--filename[="..."]] [-d|--directory[=".
.."]] [--encoding[="..."]] [-e|--extensions[="..."]] [-i|--ignore[="..."]] [-
-ignore-tags[="..."]] [--hidden] [--ignore-symlinks] [-m|--markers[="..."]] [
--title[="..."]] [--force] [--validate] [--visibility[="..."]] [--defaultpack
agename[="..."]] [--sourcecode] [-p|--progressbar] [--template[="..."]] [--pa
rseprivate] [-c|--config[="..."]]
Initializing parser and collecting files ..
[InvalidArgumentException]
Either an empty path or root was given:
project:run [-t|--target[="..."]] [-f|--filename[="..."]] [-d|--directory[=".
.."]] [--encoding[="..."]] [-e|--extensions[="..."]] [-i|--ignore[="..."]] [-
-ignore-tags[="..."]] [--hidden] [--ignore-symlinks] [-m|--markers[="..."]] [
--title[="..."]] [--force] [--validate] [--visibility[="..."]] [--defaultpack
agename[="..."]] [--sourcecode] [-p|--progressbar] [--template[="..."]] [--pa
rseprivate] [-c|--config[="..."]]
A command option is available but is not documented, the following command have to be documented :
This issue is related to #10.
All the options passed to the run
command have to be documented in the README.MD file.
NOTE: Their is a known Windows issue with the --template
parameter when the phpDocumentor PHAR file is used. The documentation should indicate that Windows users have to use the system phpdoc
command if they want to use the --template
parameter. This should be temporary until the issue is fixed by the phpDocumentor team.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.