Travis: build phpdoc and cleanup travis.yml

Author: marc-mabe

.travis.yml

@@ -1,34 +1,76 @@
 sudo: false
 language: php
 
-php:
- - 5.3.3
- - 5.3
- - 5.4
- - 5.5
- - 5.6
- - 7.0
- - nightly
- - hhvm
+cache:
+  directories:
+    - $HOME/.composer/cache
+    - $HOME/.local
+    - $HOME/ocular.phar
+    - $HOME/phpDocumentor.phar
 
-install:
- - if [ "$TRAVIS_PHP_VERSION" = "5.3.3" ]; then composer config -g disable-tls true; composer config -g secure-http false; fi
- - composer install -n
+env:
+  global:
+    - CODE_COVERAGE="0"
+    - PHPDOC="0"
+
+matrix:
+  fast_finish: true
+  include:
+    - php: 5.3.3
+    - php: 5.3
+    - php: 5.4
+      env:
+        - CODE_COVERAGE="1"
+    - php: 5.5
+    - php: 5.6
+      env:
+        - PHPDOC="1"
+    - php: 7.0
+      env:
+        - CODE_COVERAGE="1"
+    - php: nightly
+    - php: hhvm
+  allow_failures:
+    - php: nightly
 
-before_script:
- - CODE_COVERAGE=`echo $TRAVIS_PHP_VERSION | grep -v "hhvm" | wc -l`
+install:
+  - if [ "${CODE_COVERAGE}" == "0" ]; then
+      phpenv config-rm xdebug.ini || return 0;
+    fi
+  - if [ "${CODE_COVERAGE}" == "1" ]; then
+      wget -q -N -t 3 --retry-connrefused 'https://scrutinizer-ci.com/ocular.phar' || return 0;
+    fi
+  - if [ "${PHPDOC}" == "1" ]; then
+      wget -q -N -t 3 --retry-connrefused 'https://github.com/phpDocumentor/phpDocumentor2/releases/download/v2.9.0/phpDocumentor.phar' || return 0;
+      composer require --no-update --dev "evert/phpdoc-md:~0.2.0" || return 0;
+    fi
+  - if [ "${TRAVIS_PHP_VERSION}" == "5.3.3" ]; then
+        composer config -g disable-tls true &&
+        composer config -g secure-http false;
+    fi
+  - composer install -n
 
 script:
- - if [ "$CODE_COVERAGE" = "1" ]; then php vendor/bin/phpunit --verbose --coverage-text --coverage-clover=coverage.clover; else php vendor/bin/phpunit --verbose; fi
+  - if [ "$CODE_COVERAGE" == "1" ]; then
+      php vendor/bin/phpunit --verbose --coverage-text --coverage-clover=coverage.clover;
+    else
+      php vendor/bin/phpunit --verbose;
+    fi
 
 after_script:
- - if [ "$CODE_COVERAGE" = "1" ]; then wget "https://scrutinizer-ci.com/ocular.phar"; fi
- - if [ "$CODE_COVERAGE" = "1" ]; then php ocular.phar code-coverage:upload --format=php-clover coverage.clover; fi
-
-matrix:
- fast_finish: true
- allow_failures:
-  - php: nightly
+  - if [ "${CODE_COVERAGE}" == "1" ]; then
+      php ocular.phar code-coverage:upload --format=php-clover coverage.clover;
+    fi
+  - if [ "${PHPDOC}" == "1" ]; then
+      git clone "https://${CI_USER_TOKEN}@github.com/marc-mabe/php-enum.wiki.git" &&
+      php phpDocumentor.phar -d src -t docs/ --template="xml" &&
+      php vendor/bin/phpdocmd --lt '%c' --index 'Home.md' docs/structure.xml php-enum.wiki/ &&
+      cp php-enum.wiki/Home.md php-enum.wiki/_Sidebar.md &&
+      cd php-enum.wiki/ &&
+      git add . &&
+      git commit -m "auto generated PHP doc" &&
+      git push origin master:master;
+    fi
 
 notifications:
- email: false
+  email: false

README.md

@@ -26,6 +26,10 @@ It's an abstract class that needs to be extended to use it.
 
 # Usage
 
+## PHPDoc
+
+You can find auto-generated PHP documentation in the [wiki](https://github.com/marc-mabe/php-enum/wiki).
+
 ## Basics
 
 ```php
@@ -72,7 +76,7 @@ It's an abstract class that needs to be extended to use it.
 
 ## Type-Hint
 
-```php    
+```php
     use MabeEnum\Enum;
 
     class User
@@ -163,7 +167,7 @@ Internally the ```EnumMap``` is based of ```SplObjectStorage```.
 
 An ```EnumSet``` groups enumerators of the same enumeration type together.
 
-Internally it's based on a bit set of a binary string.
+Internally it's based on a bitset of a binary string.
 
 Enumerators will be ordered by the ordinal number.
 

composer.json

@@ -37,7 +37,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "2.2-dev",
+            "dev-master": "2.3-dev",
             "dev-1.x":    "1.3-dev"
         }
     }

src/EnumSet.php

@@ -7,7 +7,7 @@
 use InvalidArgumentException;
 
 /**
- * EnumSet implementation in base of an integer bit set
+ * This EnumSet is based on a bitset of a binary string.
  *
  * @link http://github.com/marc-mabe/php-enum for the canonical source repository
  * @copyright Copyright (c) 2015 Marc Bennewitz