Fix CS
authorChristian Weiske <cweiske@cweiske.de>
Thu, 23 Mar 2017 15:16:34 +0000 (16:16 +0100)
committerChristian Weiske <cweiske@cweiske.de>
Thu, 23 Mar 2017 15:16:34 +0000 (16:16 +0100)
src/phar-stub.php
src/shpub/Autoloader.php
src/shpub/Cli.php
src/shpub/Command/AbstractProps.php
src/shpub/Command/Connect.php
src/shpub/Command/Rsvp.php
src/shpub/Request.php

index 3b09dd99f8f81c25fc6491544787bbfa867cb246..653c0d0b0ad31bee0d5a4cd7aa1913a48ac56864 100644 (file)
@@ -5,8 +5,6 @@
  *
  * PHP version 5
  *
- * @category  Tools
- * @package   shpub
  * @author    Christian Weiske <cweiske@cweiske.de>
  * @copyright 2016 Christian Weiske
  * @license   http://www.gnu.org/licenses/agpl.html GNU AGPL v3
index 5c0781b6d20567eddd7bba3c06c1ac24789b0ac9..d01a7e8e03215a319c2c991e3c097f805e421467 100644 (file)
@@ -4,25 +4,19 @@
  *
  * PHP version 5
  *
- * @category  Tools
- * @package   shpub
- * @author    Christian Weiske <cweiske@cweiske.de>
- * @copyright 2014 Christian Weiske
- * @license   http://www.gnu.org/licenses/agpl.html GNU AGPL v3
- * @link      http://cweiske.de/shpub.htm
+ * @author  Christian Weiske <cweiske@cweiske.de>
+ * @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 <cweiske@cweiske.de>
- * @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 <cweiske@cweiske.de>
+ * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3
+ * @version Release: @package_version@
+ * @link    http://cweiske.de/shpub.htm
  */
 class Autoloader
 {
index 24207a108f71f0e76d1107567aeb3aef7bae5d4e..8ea550eefbe5ba222fc1a3d64c9f06d4cf56c623 100644 (file)
@@ -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
      */
index 90cc0fff70d7bfaaaea3da7e0767ade61656dc06..e186819f49b26a907660a50854f87c028f9ee06f 100644 (file)
@@ -3,6 +3,10 @@ namespace shpub;
 
 /**
  * Abstract command class that handles generic properties
+ *
+ * @author  Christian Weiske <cweiske@cweiske.de>
+ * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3
+ * @link    http://cweiske.de/shpub.htm
  */
 class Command_AbstractProps
 {
index caf5acc12a23dce8f4cef22fd9b26905ef8dbd18..c855e66690b8b91ab2cbe302d484fcc8e386da72 100644 (file)
@@ -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 <cweiske@cweiske.de>
+ * @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',
             )
index 4db6b6e36cc84d3695aeed6cfd7407b03a4b61c6..edf06cc8d91fe2ead34137502363f07a76d14a7e 100644 (file)
@@ -3,6 +3,10 @@ namespace shpub;
 
 /**
  * Repondez s'il vous plait - an answer to an invitation
+ *
+ * @author  Christian Weiske <cweiske@cweiske.de>
+ * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3
+ * @link    http://cweiske.de/shpub.htm
  */
 class Command_Rsvp extends Command_AbstractProps
 {
index 07138720c26cf7a4cc3f4139547d66a00746f69a..3614d5d69100ff4b1d5a92e25a6da58233068c44 100644 (file)
@@ -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)
     {