Documentation Fixes & Improvements

CHANGELOG.md

@@ -0,0 +1,66 @@
+### v0.4.1
+
+* Feat: add changelog (#49) e4ea6fe
+* Fix: api docs (#50) 728d698
+
+### v0.4.0
+
+* Implement Kilopascal and Megapascal and write tests (#29) e1bc33c (@arubacao)
+* remove composer.lock from repo and add it to .gitignore (#30) 37e0f01 (@arubacao)
+* Fix: add missing self conversions for temperature units (#31) 380bdb7
+* Feature/improve travis file (#32) 707fb0a (@arubacao)
+* Adding energy units (#33) 0860032 (@andrewboerema)
+* Added millibar as pressure unit (#34) 9a6eed0 (@teunw)
+* Added time measurements (#35) 611293e (@teunw)
+* Feat: add simple contributing guide for now (#36) cd71bbc
+* Added last weight measures (#37) dc7021e (@teunw)
+* Add first set of dev docs (#44) ca74697
+* scientificSymbol property, getter and setter are added (#47) 19837f1 (@luchianenco)
+* Upgrade: docs & composer version 7c553ad
+* Fix: Energy integration test - wrong unit case for Joule 708f021
+
+### v0.3.9-beta
+
+* Base working package (#26)
+* Feat: add speed base unit
+* Feat: add support for metre per second units
+* Feat: add support for kilometer per hour units
+* Feat: add support for miles per hour units
+* Fix: name spelling
+* Fix: swap units of miles and kilometres per hour
+* Fix: all units now use configure() method to configure data
+* Feat: add base temperature unit class
+* Feat: add kelvin temperature unit
+* Feat: add support for celsius
+* Feat: add support for fahrenheit units
+* Fix: using new ::configure() method over explicit value definitions
+* Fix: configure method definition
+* Update: add conversion formulae to calculate methods
+* Feat: add integration test for temp' units - damn °C <-> °F conversions
+* Fix: returned getter to being just that; a getter.
+* Feat: convert() method to expose calculate() - allows for complex calcs
+* Feat: add switch for conditional calculations based upon temp' unit
+* Fix: improper namespace
+* Feat: add base volume unit class + integration test
+* Feat: add support for litre units
+* Feat: add support for mililitre units
+* Feat: add support for US liquid pint units
+* Feat: add support for US Liquid gallon units
+* Feat: add support for cubic metre units
+* Fix: misnamed test file
+* Feat: add support for basic pressure units w/ single integration test
+* Feat: add basic energy units
+* Feat: add gram unit support
+* Feat: add base mass unit class
+* Feat: add kilogram unit support
+* Fix: changed use of "weight" with "mass"
+* Feat: add support for milligram units
+* Feat: add support for Newton units
+* Feat: add support for Pound units
+* Feat: add support for ounce units
+* Feat: add support for metric tonne units
+* Update: move example file
+* Feat: add phpdoc configurations
+* Fix: broken tests using incorrect type of measure for mass, was 'volume'
+* Update: temporary readme 'overhaul'
+* Upgrade: package version

README.md

@@ -9,6 +9,8 @@
 
 Convert all kinds of standard units of measurement from one to another with this highly customizable, easy to use, lightweight PHP component.
 
+**[API Documentation](https://jordanbrauer.github.io/unit-converter/)**
+
 **Table of Contents:**
 
 1. About the Component

apigen.yml

@@ -0,0 +1,5 @@
+parameters:
+    visibilityLevels: [public, protected]
+    annotationGroups: [todo, deprecated, note]
+    title: "Unit Converter API"
+    overwrite: true

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "jordanbrauer/unit-converter",
   "description": "Convert standard units from one to another with this easy to use, lightweight package",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "type": "component",
   "license": "MIT",
   "authors": [
@@ -11,15 +11,16 @@
     }
   ],
   "scripts": {
-    "docs": "./dev/docs.sh && phpdoc --config=./phpdoc.xml",
+    "docs": "./dev/docs.sh",
     "test": "phpunit --configuration=./phpunit.xml --testsuite=fullspec --color=always",
     "unit": "phpunit --configuration=./phpunit.xml --testsuite=unit --color=always",
     "integration": "phpunit --configuration=./phpunit.xml --testsuite=integration --color=always"
   },
   "require": {},
   "require-dev": {
-    "phpdocumentor/phpdocumentor": "^2.9",
+    "apigen/apigen": "dev-master",
     "phpunit/phpunit": "^6.3",
+    "roave/better-reflection": "dev-master#c87d856",
     "symfony/var-dumper": "^3.3"
   },
   "autoload": {

dev/docs.sh

@@ -8,19 +8,16 @@
 #
 # $ chmod u+x ./dev/docs.sh
 
-DIRECTORY=./docs
+SOURCE=./src
+DESTINATION=./docs
 
-if [ -d $DIRECTORY ];
+if [ -d $DESTINATION ];
 then
   printf "Deleting old generated documentation .. "
-
-  rm -r $DIRECTORY/*
-
+  rm -r $DESTINATION/*
   echo "OK"
-
-  exit
 fi
 
 echo "No stale documentation to remove"
-
+php -d memory_limit=-1 -f ./vendor/bin/apigen generate $SOURCE --destination $DESTINATION
 exit

docs/.htaccess

@@ -0,0 +1,5 @@
+# Fixes a vulnerability in CentOS: http://stackoverflow.com/questions/20533279/prevent-php-from-parsing-non-php-files-such-as-somefile-php-txt
+<FilesMatch \.php\.txt$>
+    RemoveHandler .php
+    ForceType text/plain
+</FilesMatch>