Update Documentation & readme

README.md

@@ -9,7 +9,8 @@
 [![Coverage](https://api.codacy.com/project/badge/Coverage/f3569cf671f04b8ab6d699be3fd011e5)](https://www.codacy.com/app/alphayax/freebox_api_php?utm_source=github.com&utm_medium=referral&utm_content=alphayax/freebox_api_php&utm_campaign=Badge_Coverage)
 [![Codacy](https://api.codacy.com/project/badge/Grade/f3569cf671f04b8ab6d699be3fd011e5)](https://www.codacy.com/app/alphayax/freebox_api_php?utm_source=github.com&utm_medium=referral&utm_content=alphayax/freebox_api_php&utm_campaign=Badge_Grade)
 
-![license](https://img.shields.io/packagist/l/alphayax/freebox_api_php.svg)
+[![License](https://poser.pugx.org/alphayax/freebox_api_php/license)](https://packagist.org/packages/alphayax/freebox_api_php)
+[![Total Downloads](https://poser.pugx.org/alphayax/freebox_api_php/downloads)](https://packagist.org/packages/alphayax/freebox_api_php)
 
 
 Implementation PHP de l'API de la freebox (dans sa version 3).
@@ -23,16 +24,16 @@ Pensez à installer les dependences :)
 
 L'intégralité des fonctionnalités de l'API Freebox (v3) sont implémentées :
 
-- [AirMedia](docs/AirMedia/AirMedia.md)
-- [Call](docs/Call/Call.md)
-- [Configuration](docs/config/config.md)
-- [Download](docs/download/download.md)
-- [FileSystem](docs/FileSystem/FileSystem.md)
-- [Parental Control](docs/ParentalControl/ParentalControl.md)
-- [RRD](docs/RRD/RRD.md)
-- [Storage](docs/Storage/Storage.md)
+- [AirMedia](docs/services/AirMedia/AirMedia.md)
+- [Call](docs/services/Call/Call.md)
+- [Configuration](docs/services/config/config.md)
+- [Download](docs/services/download/download.md)
+- [FileSystem](docs/services/FileSystem/FileSystem.md)
+- [Parental Control](docs/services/ParentalControl/ParentalControl.md)
+- [RRD](docs/services/RRD/RRD.md)
+- [Storage](docs/services/Storage/Storage.md)
 
-Un document complet repertorie l'ensemble des services implémentées : [services.md](docs/services.md)
+Un document complet repertorie l'ensemble des services implémentées : [services.md](docs/services/services.md)
 
 ## Utilisation
 

composer.json

@@ -16,9 +16,10 @@
     "monolog/monolog": "^1.9.1"
   },
   "require-dev" : {
+    "alphayax/phpdoc_md" : "^1.0.1",
+    "codacy/coverage": "<2.0.0",
     "phpunit/phpunit": "^5.4.0",
-    "zf1/zend-reflection": "1.12.*",
-    "codacy/coverage": "<2.0.0"
+    "zf1/zend-reflection": "1.12.*"
   },
   "autoload": {
     "psr-4": {

docs/generate.php

@@ -0,0 +1,11 @@
+<?php
+
+require_once '../vendor/autoload.php';
+
+$srcDir     = __DIR__.'/../freebox/api/v3/services';
+$namespace  = 'alphayax\freebox\api\v3\services';
+
+/// Services documentation
+$gen = new \alphayax\mdGen\MdGen( $srcDir, $namespace);
+$gen->filterSubClasses( \alphayax\freebox\api\v3\Service::class);
+$gen->generate( 'services');

docs/services/login/login.md

@@ -17,7 +17,6 @@
 
 | Method | Description |
 |---|---|
-| `__construct` | Authorize constructor. | 
 | `ask_authorization` | Contact the freebox and ask for App auth | 
 | `get_authorization_status` |  | 
 | `getStatus` |  |