*
* 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
*
* 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
{
/**
* Let the CLI option parser parse the options.
*
- * @param object $parser Option parser
+ * @param object $optParser Option parser
*
* @return object Parsed command line parameters
*/
/**
* 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
{
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
{
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',
)
/**
* 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
{
}
/**
+ * 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)
{
}
/**
+ * Execute the file upload
+ *
+ * @param string $fileName File path
+ *
* @return string URL at media endpoint
*/
public function uploadToMediaEndpoint($fileName)
*
* @param string $key Parameter name
* @param string|array $values One or multiple values
+ *
+ * @return void
*/
public function addProperty($key, $values)
{