From 13389615bec6fd29a3e7d12f7f721631ace9ec65 Mon Sep 17 00:00:00 2001 From: alphayax Date: Sun, 12 Jun 2016 11:16:37 +0200 Subject: [PATCH] Update Documentation & readme --- README.md | 21 ++++++++++--------- composer.json | 5 +++-- docs/generate.php | 11 ++++++++++ docs/{ => services}/AirMedia/AirMedia.md | 0 docs/{ => services}/Call/Call.md | 0 docs/{ => services}/Call/Contact/Contact.md | 0 docs/{ => services}/FileSystem/FileSystem.md | 0 .../ParentalControl/ParentalControl.md | 0 docs/{ => services}/RRD/RRD.md | 0 docs/{ => services}/Storage/Storage.md | 0 .../config/Connection/Connection.md | 0 .../config/Connection/DynDns/DynDns.md | 0 docs/{ => services}/config/LAN/LAN.md | 0 docs/{ => services}/config/NAT/NAT.md | 0 .../config/NetworkShare/NetworkShare.md | 0 .../config/SwitchPort/SwitchPort.md | 0 docs/{ => services}/config/UPnP/UPnP.md | 0 .../config/VPN/Client/Client.md | 0 .../config/VPN/Server/Server.md | 0 docs/{ => services}/config/VPN/VPN.md | 0 docs/{ => services}/config/WiFi/WiFi.md | 0 docs/{ => services}/config/config.md | 0 docs/{ => services}/download/download.md | 0 docs/{ => services}/login/login.md | 1 - docs/{ => services}/services.md | 0 25 files changed, 25 insertions(+), 13 deletions(-) create mode 100644 docs/generate.php rename docs/{ => services}/AirMedia/AirMedia.md (100%) rename docs/{ => services}/Call/Call.md (100%) rename docs/{ => services}/Call/Contact/Contact.md (100%) rename docs/{ => services}/FileSystem/FileSystem.md (100%) rename docs/{ => services}/ParentalControl/ParentalControl.md (100%) rename docs/{ => services}/RRD/RRD.md (100%) rename docs/{ => services}/Storage/Storage.md (100%) rename docs/{ => services}/config/Connection/Connection.md (100%) rename docs/{ => services}/config/Connection/DynDns/DynDns.md (100%) rename docs/{ => services}/config/LAN/LAN.md (100%) rename docs/{ => services}/config/NAT/NAT.md (100%) rename docs/{ => services}/config/NetworkShare/NetworkShare.md (100%) rename docs/{ => services}/config/SwitchPort/SwitchPort.md (100%) rename docs/{ => services}/config/UPnP/UPnP.md (100%) rename docs/{ => services}/config/VPN/Client/Client.md (100%) rename docs/{ => services}/config/VPN/Server/Server.md (100%) rename docs/{ => services}/config/VPN/VPN.md (100%) rename docs/{ => services}/config/WiFi/WiFi.md (100%) rename docs/{ => services}/config/config.md (100%) rename docs/{ => services}/download/download.md (100%) rename docs/{ => services}/login/login.md (93%) rename docs/{ => services}/services.md (100%) diff --git a/README.md b/README.md index 0233393..d4e8e7c 100644 --- a/README.md +++ b/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 diff --git a/composer.json b/composer.json index bfbb52f..2ac6c73 100644 --- a/composer.json +++ b/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": { diff --git a/docs/generate.php b/docs/generate.php new file mode 100644 index 0000000..255dd72 --- /dev/null +++ b/docs/generate.php @@ -0,0 +1,11 @@ +filterSubClasses( \alphayax\freebox\api\v3\Service::class); +$gen->generate( 'services'); diff --git a/docs/AirMedia/AirMedia.md b/docs/services/AirMedia/AirMedia.md similarity index 100% rename from docs/AirMedia/AirMedia.md rename to docs/services/AirMedia/AirMedia.md diff --git a/docs/Call/Call.md b/docs/services/Call/Call.md similarity index 100% rename from docs/Call/Call.md rename to docs/services/Call/Call.md diff --git a/docs/Call/Contact/Contact.md b/docs/services/Call/Contact/Contact.md similarity index 100% rename from docs/Call/Contact/Contact.md rename to docs/services/Call/Contact/Contact.md diff --git a/docs/FileSystem/FileSystem.md b/docs/services/FileSystem/FileSystem.md similarity index 100% rename from docs/FileSystem/FileSystem.md rename to docs/services/FileSystem/FileSystem.md diff --git a/docs/ParentalControl/ParentalControl.md b/docs/services/ParentalControl/ParentalControl.md similarity index 100% rename from docs/ParentalControl/ParentalControl.md rename to docs/services/ParentalControl/ParentalControl.md diff --git a/docs/RRD/RRD.md b/docs/services/RRD/RRD.md similarity index 100% rename from docs/RRD/RRD.md rename to docs/services/RRD/RRD.md diff --git a/docs/Storage/Storage.md b/docs/services/Storage/Storage.md similarity index 100% rename from docs/Storage/Storage.md rename to docs/services/Storage/Storage.md diff --git a/docs/config/Connection/Connection.md b/docs/services/config/Connection/Connection.md similarity index 100% rename from docs/config/Connection/Connection.md rename to docs/services/config/Connection/Connection.md diff --git a/docs/config/Connection/DynDns/DynDns.md b/docs/services/config/Connection/DynDns/DynDns.md similarity index 100% rename from docs/config/Connection/DynDns/DynDns.md rename to docs/services/config/Connection/DynDns/DynDns.md diff --git a/docs/config/LAN/LAN.md b/docs/services/config/LAN/LAN.md similarity index 100% rename from docs/config/LAN/LAN.md rename to docs/services/config/LAN/LAN.md diff --git a/docs/config/NAT/NAT.md b/docs/services/config/NAT/NAT.md similarity index 100% rename from docs/config/NAT/NAT.md rename to docs/services/config/NAT/NAT.md diff --git a/docs/config/NetworkShare/NetworkShare.md b/docs/services/config/NetworkShare/NetworkShare.md similarity index 100% rename from docs/config/NetworkShare/NetworkShare.md rename to docs/services/config/NetworkShare/NetworkShare.md diff --git a/docs/config/SwitchPort/SwitchPort.md b/docs/services/config/SwitchPort/SwitchPort.md similarity index 100% rename from docs/config/SwitchPort/SwitchPort.md rename to docs/services/config/SwitchPort/SwitchPort.md diff --git a/docs/config/UPnP/UPnP.md b/docs/services/config/UPnP/UPnP.md similarity index 100% rename from docs/config/UPnP/UPnP.md rename to docs/services/config/UPnP/UPnP.md diff --git a/docs/config/VPN/Client/Client.md b/docs/services/config/VPN/Client/Client.md similarity index 100% rename from docs/config/VPN/Client/Client.md rename to docs/services/config/VPN/Client/Client.md diff --git a/docs/config/VPN/Server/Server.md b/docs/services/config/VPN/Server/Server.md similarity index 100% rename from docs/config/VPN/Server/Server.md rename to docs/services/config/VPN/Server/Server.md diff --git a/docs/config/VPN/VPN.md b/docs/services/config/VPN/VPN.md similarity index 100% rename from docs/config/VPN/VPN.md rename to docs/services/config/VPN/VPN.md diff --git a/docs/config/WiFi/WiFi.md b/docs/services/config/WiFi/WiFi.md similarity index 100% rename from docs/config/WiFi/WiFi.md rename to docs/services/config/WiFi/WiFi.md diff --git a/docs/config/config.md b/docs/services/config/config.md similarity index 100% rename from docs/config/config.md rename to docs/services/config/config.md diff --git a/docs/download/download.md b/docs/services/download/download.md similarity index 100% rename from docs/download/download.md rename to docs/services/download/download.md diff --git a/docs/login/login.md b/docs/services/login/login.md similarity index 93% rename from docs/login/login.md rename to docs/services/login/login.md index 11f1434..78d19e5 100644 --- a/docs/login/login.md +++ b/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` | | diff --git a/docs/services.md b/docs/services/services.md similarity index 100% rename from docs/services.md rename to docs/services/services.md