From: Christian Weiske Date: Thu, 23 Mar 2017 15:16:34 +0000 (+0100) Subject: Fix CS X-Git-Tag: v0.4.0~5 X-Git-Url: https://git.cweiske.de/shpub.git/commitdiff_plain/f60fce4bd4a0cba54b686f64bc5a83eb580356f4?hp=78c61f9aba8988aa8ceecb183aa51ee533681f5c Fix CS --- diff --git a/src/phar-stub.php b/src/phar-stub.php index 3b09dd9..653c0d0 100644 --- a/src/phar-stub.php +++ b/src/phar-stub.php @@ -5,8 +5,6 @@ * * PHP version 5 * - * @category Tools - * @package shpub * @author Christian Weiske * @copyright 2016 Christian Weiske * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3 diff --git a/src/shpub/Autoloader.php b/src/shpub/Autoloader.php index 5c0781b..d01a7e8 100644 --- a/src/shpub/Autoloader.php +++ b/src/shpub/Autoloader.php @@ -4,25 +4,19 @@ * * PHP version 5 * - * @category Tools - * @package shpub - * @author Christian Weiske - * @copyright 2014 Christian Weiske - * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3 - * @link http://cweiske.de/shpub.htm + * @author Christian Weiske + * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3 + * @link http://cweiske.de/shpub.htm */ namespace shpub; /** * Class autoloader, PSR-0 compliant. * - * @category Tools - * @package shpub - * @author Christian Weiske - * @copyright 2014 Christian Weiske - * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3 - * @version Release: @package_version@ - * @link http://cweiske.de/shpub.htm + * @author Christian Weiske + * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3 + * @version Release: @package_version@ + * @link http://cweiske.de/shpub.htm */ class Autoloader { diff --git a/src/shpub/Cli.php b/src/shpub/Cli.php index 24207a1..8ea550e 100644 --- a/src/shpub/Cli.php +++ b/src/shpub/Cli.php @@ -50,7 +50,7 @@ class Cli /** * Let the CLI option parser parse the options. * - * @param object $parser Option parser + * @param object $optParser Option parser * * @return object Parsed command line parameters */ diff --git a/src/shpub/Command/AbstractProps.php b/src/shpub/Command/AbstractProps.php index 90cc0ff..e186819 100644 --- a/src/shpub/Command/AbstractProps.php +++ b/src/shpub/Command/AbstractProps.php @@ -3,6 +3,10 @@ namespace shpub; /** * Abstract command class that handles generic properties + * + * @author Christian Weiske + * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3 + * @link http://cweiske.de/shpub.htm */ class Command_AbstractProps { diff --git a/src/shpub/Command/Connect.php b/src/shpub/Command/Connect.php index caf5acc..c855e66 100644 --- a/src/shpub/Command/Connect.php +++ b/src/shpub/Command/Connect.php @@ -2,8 +2,13 @@ namespace shpub; /** - * @link http://micropub.net/draft/ - * @link http://indieweb.org/authorization-endpoint + * Connect to a micropub server to get an access token. + * + * @author Christian Weiske + * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3 + * @link http://cweiske.de/shpub.htm + * @link http://micropub.net/draft/ + * @link http://indieweb.org/authorization-endpoint */ class Command_Connect { @@ -33,7 +38,8 @@ class Command_Connect array( 'short_name' => '-s', 'long_name' => '--scope', - 'description' => 'Space-separated list of scopes to request (default create)', + 'description' => 'Space-separated list of scopes to request' + . ' (default: create)', 'action' => 'StoreString', 'default' => 'create', ) diff --git a/src/shpub/Command/Rsvp.php b/src/shpub/Command/Rsvp.php index 4db6b6e..edf06cc 100644 --- a/src/shpub/Command/Rsvp.php +++ b/src/shpub/Command/Rsvp.php @@ -3,6 +3,10 @@ namespace shpub; /** * Repondez s'il vous plait - an answer to an invitation + * + * @author Christian Weiske + * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3 + * @link http://cweiske.de/shpub.htm */ class Command_Rsvp extends Command_AbstractProps { diff --git a/src/shpub/Request.php b/src/shpub/Request.php index 0713872..3614d5d 100644 --- a/src/shpub/Request.php +++ b/src/shpub/Request.php @@ -143,8 +143,12 @@ class Request } /** + * Add file upload + * * @param string $fieldName name of file-upload field * @param array $fileNames list of local file paths + * + * @return void */ public function addUpload($fieldName, $fileNames) { @@ -180,6 +184,10 @@ class Request } /** + * Execute the file upload + * + * @param string $fileName File path + * * @return string URL at media endpoint */ public function uploadToMediaEndpoint($fileName) @@ -230,6 +238,8 @@ class Request * * @param string $key Parameter name * @param string|array $values One or multiple values + * + * @return void */ public function addProperty($key, $values) {