Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bgaillard committed Jan 28, 2014
1 parent 20009b9 commit 0c1c0b3
Showing 1 changed file with 11 additions and 21 deletions.
32 changes: 11 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ Default value: `phpdoc`

Path to the phpdoc executable, by default it will use the one that come with task. It is located on the bin folder.

**WARNING** : We kept this option documented here only for version `0.1.0` and `0.3.0` of the plugin. This option has
been remove the version `0.4.0` because it was not portable across operating systems.
**WARNING** : We kept this option documented here only for versions `0.1.0` and `0.3.0` of the plugin. This option has
been removed in version `0.4.0` because it was not portable across operating systems.

#### options.directory( optional )
Type: `String`
Expand All @@ -61,14 +61,11 @@ where Gruntfile is located.
Type: `String`
Default value: undefined

This option is not integrated in phpDocumentor tool and is an option specific to the Grunt phpDocumentor plugin. The
purpose of this option is to allow you to provide a path to a custom phpDocumentor PHAR file or to indicate to the
plugin to use the `phpdoc` command available in your system.
This option is not integrated in phpDocumentor tool and is specific to the plugin. The purpose of this option is to allow you to provide a path to a custom phpDocumentor PHAR file or to indicate to the plugin to use the `phpdoc` command available in your system.

If this option is not specified then the plugin will automatically use the phpDocumentor PHAR file which is integrated
inside it.
If this option is not specified then the plugin will automatically use the integrated phpDocumentor PHAR file.

If you want to provide a path to a custom PHAR file you have to provide it as a string :
If you want to provide a path to a custom PHAR file you can provide it as a string :

```js
grunt.initConfig({
Expand All @@ -80,8 +77,7 @@ grunt.initConfig({
})
```

If you want to use the `phpdoc` command which is available on you system instead then you only have to pass the `null`
value to the `phar` option :
If you want to use the `phpdoc` command which is available on you system instead then you can the `null` value to the `phar` option :

```js
grunt.initConfig({
Expand All @@ -107,24 +103,18 @@ Path where to store the generated output. It will default to a folder named 'doc

### 0.4.0

* **BREAKING CHANGE, WARNING**: Now the `bin` option has been deleted and replaced by the `phar` option, if `null` is
passed to the `phar` option then the plugin uses the `phpdoc` command available, if the `phar` option is `undefined`
then the plugin uses the packaged phpDocumentor PHAR, if the `phar` option is not `null` and not `undefined` then it
express a path to a phpDocumentor PHAR file on the file system
* **BREAKING CHANGE, WARNING**: The `bin` option has been deleted and replaced by the `phar` option, if `null` is passed to the `phar` option then the plugin uses the `phpdoc` command available, if the `phar` option is `undefined` then the plugin uses the packaged phpDocumentor PHAR, if the `phar` option is not `null` and not `undefined` then it express a path to a phpDocumentor PHAR file on the file system
* Add more robust unit tests
* The unit tests are executed on the `develop` branch with the GoMoob continuous integration server each time the
source code is updated on this branch
* Now the plugin inspects the `[Exception]` string in the phpDocumentor output to know if a phpDocumentor exception has
been encountered and make the Grunt task fail
* The unit tests are executed on the `develop` branch with the GoMoob continuous integration server each time the source code is updated on this branch
* Now the plugin inspects the `[Exception]` string in the phpDocumentor output to know if a phpDocumentor exception has been encountered and make the Grunt task fail
* Add the build with grunt badge to the README.MD file
* Global documentation improvements
* Add lot of comments in the plugin code
* The `bin\phpdoc` bash script has been deleted because bash is not installed on all UNIX platforms and because using
a bash script is not portable across platforms
* The `bin\phpdoc` bash script has been deleted because bash is not installed on all UNIX platforms and because using a bash script is not portable across platforms
* Upgrade the phpDocumentor PHAR to version 2.2.0 of phpDocumentor
* Remove the use of the loadash `_.extend()` function and replace it with the standard Grunt `task.options()` function
* Now the plugin checks if PHP CLI is available at command line
* Global refactoring
* Global refactorings
* Begin to support the execution of the `help`, `parse`, `project:parse`, `transform`, `project:transform`, `list`,
`template:list` commands

Expand Down

0 comments on commit 0c1c0b3

Please sign in to comment.