[Pkg-owncloud-commits] [php-sabredav] 01/03: Fixing lots of broken docblocks.
David Prévot
taffit at moszumanska.debian.org
Tue Aug 11 13:35:32 UTC 2015
This is an automated email from the git hooks/post-receive script.
taffit pushed a commit to tag 3.0.2
in repository php-sabredav.
commit 0e1df66477f67ee3f85679857abf3c80628e76c0
Author: Evert Pot <me at evertpot.com>
Date: Mon Jul 20 16:14:06 2015 -0400
Fixing lots of broken docblocks.
Thanks @waltertamboer !
---
lib/CalDAV/Calendar.php | 1 +
lib/CalDAV/Notifications/Plugin.php | 2 ++
lib/CalDAV/Schedule/IMipPlugin.php | 2 +-
lib/CalDAV/Schedule/Inbox.php | 1 +
lib/CalDAV/Subscriptions/Plugin.php | 2 ++
lib/CalDAV/Xml/Notification/InviteReply.php | 2 ++
lib/CardDAV/AddressBook.php | 1 +
lib/CardDAV/Plugin.php | 4 ++++
lib/DAV/Auth/Backend/AbstractBasic.php | 2 +-
lib/DAV/Auth/Backend/AbstractDigest.php | 2 +-
lib/DAV/Auth/Backend/Apache.php | 2 +-
lib/DAV/Auth/Backend/BackendInterface.php | 2 +-
lib/DAV/Browser/Plugin.php | 19 ++++++++++++++++++-
lib/DAV/Client.php | 7 +++++++
lib/DAV/IMultiGet.php | 1 +
lib/DAV/Locks/Plugin.php | 1 +
lib/DAV/Mount/Plugin.php | 1 +
lib/DAV/Server.php | 5 +++++
lib/DAV/Sync/Plugin.php | 3 ++-
lib/DAV/Xml/Element/Prop.php | 1 +
lib/DAV/Xml/Response/MultiStatus.php | 1 +
lib/DAVACL/AbstractPrincipalCollection.php | 1 +
lib/DAVACL/Xml/Property/Acl.php | 2 +-
lib/DAVACL/Xml/Property/CurrentUserPrivilegeSet.php | 1 +
24 files changed, 58 insertions(+), 8 deletions(-)
diff --git a/lib/CalDAV/Calendar.php b/lib/CalDAV/Calendar.php
index d8a7117..7352a27 100644
--- a/lib/CalDAV/Calendar.php
+++ b/lib/CalDAV/Calendar.php
@@ -137,6 +137,7 @@ class Calendar implements ICalendar, DAV\IProperties, DAV\Sync\ISyncCollection,
*
* If any children are not found, you do not have to return them.
*
+ * @param string[] $paths
* @return array
*/
function getMultipleChildren(array $paths) {
diff --git a/lib/CalDAV/Notifications/Plugin.php b/lib/CalDAV/Notifications/Plugin.php
index 4bfb9b6..ed0e522 100644
--- a/lib/CalDAV/Notifications/Plugin.php
+++ b/lib/CalDAV/Notifications/Plugin.php
@@ -32,6 +32,8 @@ class Plugin extends ServerPlugin {
const NS_CALENDARSERVER = 'http://calendarserver.org/ns/';
/**
+ * Reference to the main server object.
+ *
* @var Server
*/
protected $server;
diff --git a/lib/CalDAV/Schedule/IMipPlugin.php b/lib/CalDAV/Schedule/IMipPlugin.php
index e53f04a..cd0101f 100644
--- a/lib/CalDAV/Schedule/IMipPlugin.php
+++ b/lib/CalDAV/Schedule/IMipPlugin.php
@@ -57,7 +57,7 @@ class IMipPlugin extends DAV\ServerPlugin {
*
* This method should set up the required event subscriptions.
*
- * @param Server $server
+ * @param DAV\Server $server
* @return void
*/
function initialize(DAV\Server $server) {
diff --git a/lib/CalDAV/Schedule/Inbox.php b/lib/CalDAV/Schedule/Inbox.php
index d6e990c..c3b3662 100644
--- a/lib/CalDAV/Schedule/Inbox.php
+++ b/lib/CalDAV/Schedule/Inbox.php
@@ -34,6 +34,7 @@ class Inbox extends DAV\Collection implements IInbox {
/**
* Constructor
*
+ * @param Backend\SchedulingSupport $caldavBackend
* @param string $principalUri
*/
function __construct(Backend\SchedulingSupport $caldavBackend, $principalUri) {
diff --git a/lib/CalDAV/Subscriptions/Plugin.php b/lib/CalDAV/Subscriptions/Plugin.php
index 1de6ed8..ef1c6cc 100644
--- a/lib/CalDAV/Subscriptions/Plugin.php
+++ b/lib/CalDAV/Subscriptions/Plugin.php
@@ -59,6 +59,8 @@ class Plugin extends ServerPlugin {
/**
* Triggered after properties have been fetched.
*
+ * @param PropFind $propFind
+ * @param INode $node
* @return void
*/
function propFind(PropFind $propFind, INode $node) {
diff --git a/lib/CalDAV/Xml/Notification/InviteReply.php b/lib/CalDAV/Xml/Notification/InviteReply.php
index 1b99d5e..ec4385d 100644
--- a/lib/CalDAV/Xml/Notification/InviteReply.php
+++ b/lib/CalDAV/Xml/Notification/InviteReply.php
@@ -86,6 +86,8 @@ class InviteReply implements NotificationInterface {
* * hostUrl - A url to the shared calendar.
* * summary - Description of the share, can be the same as the
* calendar, but may also be modified (optional).
+ *
+ * @param array $values
*/
function __construct(array $values) {
diff --git a/lib/CardDAV/AddressBook.php b/lib/CardDAV/AddressBook.php
index 31e9979..2320d1b 100644
--- a/lib/CardDAV/AddressBook.php
+++ b/lib/CardDAV/AddressBook.php
@@ -91,6 +91,7 @@ class AddressBook extends DAV\Collection implements IAddressBook, DAV\IPropertie
*
* If any children are not found, you do not have to return them.
*
+ * @param string[] $paths
* @return array
*/
function getMultipleChildren(array $paths) {
diff --git a/lib/CardDAV/Plugin.php b/lib/CardDAV/Plugin.php
index 4f38f96..f7e897a 100644
--- a/lib/CardDAV/Plugin.php
+++ b/lib/CardDAV/Plugin.php
@@ -654,6 +654,10 @@ class Plugin extends DAV\ServerPlugin {
*
* This event is scheduled late in the process, after most work for
* propfind has been done.
+ *
+ * @param DAV\PropFind $propFind
+ * @param DAV\INode $node
+ * @return void
*/
function propFindLate(DAV\PropFind $propFind, DAV\INode $node) {
diff --git a/lib/DAV/Auth/Backend/AbstractBasic.php b/lib/DAV/Auth/Backend/AbstractBasic.php
index 8a9aa56..d2dc7cf 100644
--- a/lib/DAV/Auth/Backend/AbstractBasic.php
+++ b/lib/DAV/Auth/Backend/AbstractBasic.php
@@ -127,7 +127,7 @@ abstract class AbstractBasic implements BackendInterface {
* existing one.
*
* @param RequestInterface $request
- * @param ResponseInterface $request
+ * @param ResponseInterface $response
* @return void
*/
function challenge(RequestInterface $request, ResponseInterface $response) {
diff --git a/lib/DAV/Auth/Backend/AbstractDigest.php b/lib/DAV/Auth/Backend/AbstractDigest.php
index 68acb17..53f7999 100644
--- a/lib/DAV/Auth/Backend/AbstractDigest.php
+++ b/lib/DAV/Auth/Backend/AbstractDigest.php
@@ -144,7 +144,7 @@ abstract class AbstractDigest implements BackendInterface {
* existing one.
*
* @param RequestInterface $request
- * @param ResponseInterface $request
+ * @param ResponseInterface $response
* @return void
*/
function challenge(RequestInterface $request, ResponseInterface $response) {
diff --git a/lib/DAV/Auth/Backend/Apache.php b/lib/DAV/Auth/Backend/Apache.php
index 5e3126c..a24e03e 100644
--- a/lib/DAV/Auth/Backend/Apache.php
+++ b/lib/DAV/Auth/Backend/Apache.php
@@ -86,7 +86,7 @@ class Apache implements BackendInterface {
* existing one.
*
* @param RequestInterface $request
- * @param ResponseInterface $request
+ * @param ResponseInterface $response
* @return void
*/
function challenge(RequestInterface $request, ResponseInterface $response) {
diff --git a/lib/DAV/Auth/Backend/BackendInterface.php b/lib/DAV/Auth/Backend/BackendInterface.php
index d6042f8..228086f 100644
--- a/lib/DAV/Auth/Backend/BackendInterface.php
+++ b/lib/DAV/Auth/Backend/BackendInterface.php
@@ -62,7 +62,7 @@ interface BackendInterface {
* existing one.
*
* @param RequestInterface $request
- * @param ResponseInterface $request
+ * @param ResponseInterface $response
* @return void
*/
function challenge(RequestInterface $request, ResponseInterface $response);
diff --git a/lib/DAV/Browser/Plugin.php b/lib/DAV/Browser/Plugin.php
index bc0f51f..4b4688f 100644
--- a/lib/DAV/Browser/Plugin.php
+++ b/lib/DAV/Browser/Plugin.php
@@ -406,6 +406,16 @@ class Plugin extends DAV\ServerPlugin {
}
+ /**
+ * Generates the first block of HTML, including the <head> tag and page
+ * header.
+ *
+ * Returns footer.
+ *
+ * @param string $title
+ * @param string $path
+ * @return void
+ */
function generateHeader($title, $path = null) {
$version = DAV\Version::VERSION;
@@ -456,6 +466,13 @@ HTML;
}
+ /**
+ * Generates the page footer.
+ *
+ * Returns html.
+ *
+ * @return string
+ */
function generateFooter() {
$version = DAV\Version::VERSION;
@@ -694,7 +711,7 @@ HTML;
}
- /*
+ /**
* Draws a table row for a property
*
* @param string $name
diff --git a/lib/DAV/Client.php b/lib/DAV/Client.php
index 3e6c2db..d719d38 100644
--- a/lib/DAV/Client.php
+++ b/lib/DAV/Client.php
@@ -38,6 +38,13 @@ class Client extends HTTP\Client {
*/
public $propertyMap = [];
+ /**
+ * Base URI
+ *
+ * This URI will be used to resolve relative urls.
+ *
+ * @var string
+ */
protected $baseUri;
/**
diff --git a/lib/DAV/IMultiGet.php b/lib/DAV/IMultiGet.php
index 01de782..7f6f0c4 100644
--- a/lib/DAV/IMultiGet.php
+++ b/lib/DAV/IMultiGet.php
@@ -28,6 +28,7 @@ interface IMultiGet extends ICollection {
*
* If any children are not found, you do not have to return them.
*
+ * @param string[] $paths
* @return array
*/
function getMultipleChildren(array $paths);
diff --git a/lib/DAV/Locks/Plugin.php b/lib/DAV/Locks/Plugin.php
index 6b92744..dc16d5a 100644
--- a/lib/DAV/Locks/Plugin.php
+++ b/lib/DAV/Locks/Plugin.php
@@ -409,6 +409,7 @@ class Plugin extends DAV\ServerPlugin {
* must be present in the request, and reject requests without the proper
* tokens.
*
+ * @param RequestInterface $request
* @param mixed $conditions
* @return void
*/
diff --git a/lib/DAV/Mount/Plugin.php b/lib/DAV/Mount/Plugin.php
index cbd58f5..bcdb278 100644
--- a/lib/DAV/Mount/Plugin.php
+++ b/lib/DAV/Mount/Plugin.php
@@ -65,6 +65,7 @@ class Plugin extends DAV\ServerPlugin {
/**
* Generates the davmount response
*
+ * @param ResponseInterface $response
* @param string $uri absolute uri
* @return void
*/
diff --git a/lib/DAV/Server.php b/lib/DAV/Server.php
index 0d9cf8f..e2a0f08 100644
--- a/lib/DAV/Server.php
+++ b/lib/DAV/Server.php
@@ -835,6 +835,10 @@ class Server extends EventEmitter {
/**
* Small helper to support PROPFIND with DEPTH_INFINITY.
+ *
+ * @param array[] $propFindRequests
+ * @param PropFind $propFind
+ * @return void
*/
private function addPathNodesRecursively(&$propFindRequests, PropFind $propFind) {
@@ -1492,6 +1496,7 @@ class Server extends EventEmitter {
* ],
* ]
*
+ * @param RequestInterface $request
* @return array
*/
function getIfConditions(RequestInterface $request) {
diff --git a/lib/DAV/Sync/Plugin.php b/lib/DAV/Sync/Plugin.php
index b6fb8dc..22b0a63 100644
--- a/lib/DAV/Sync/Plugin.php
+++ b/lib/DAV/Sync/Plugin.php
@@ -222,7 +222,8 @@ class Plugin extends DAV\ServerPlugin {
* It's a moment where this plugin can check all the supplied lock tokens
* in the If: header, and check if they are valid.
*
- * @param mixed $conditions
+ * @param RequestInterface $request
+ * @param array $conditions
* @return void
*/
function validateTokens(RequestInterface $request, &$conditions) {
diff --git a/lib/DAV/Xml/Element/Prop.php b/lib/DAV/Xml/Element/Prop.php
index 37de041..e9e3d37 100644
--- a/lib/DAV/Xml/Element/Prop.php
+++ b/lib/DAV/Xml/Element/Prop.php
@@ -80,6 +80,7 @@ class Prop implements XmlDeserializable {
* * name - A clark-notation XML element name.
* * value - The parsed value.
*
+ * @param Reader $reader
* @return array
*/
private static function parseCurrentElement(Reader $reader) {
diff --git a/lib/DAV/Xml/Response/MultiStatus.php b/lib/DAV/Xml/Response/MultiStatus.php
index 9b8cd1a..ad33e55 100644
--- a/lib/DAV/Xml/Response/MultiStatus.php
+++ b/lib/DAV/Xml/Response/MultiStatus.php
@@ -39,6 +39,7 @@ class MultiStatus implements Element {
* Constructor
*
* @param \Sabre\DAV\Xml\Element\Response[] $responses
+ * @param string $syncToken
*/
function __construct(array $responses, $syncToken = null) {
diff --git a/lib/DAVACL/AbstractPrincipalCollection.php b/lib/DAVACL/AbstractPrincipalCollection.php
index acf12cc..9504eb2 100644
--- a/lib/DAVACL/AbstractPrincipalCollection.php
+++ b/lib/DAVACL/AbstractPrincipalCollection.php
@@ -140,6 +140,7 @@ abstract class AbstractPrincipalCollection extends DAV\Collection implements IPr
* used to call $this->getChild in the future.
*
* @param array $searchProperties
+ * @param string $test
* @return array
*/
function searchPrincipals(array $searchProperties, $test = 'allof') {
diff --git a/lib/DAVACL/Xml/Property/Acl.php b/lib/DAVACL/Xml/Property/Acl.php
index 76e2959..6a09d66 100644
--- a/lib/DAVACL/Xml/Property/Acl.php
+++ b/lib/DAVACL/Xml/Property/Acl.php
@@ -56,8 +56,8 @@ class Acl implements Element, HtmlOutput {
* are already full urls. If this is kept to true, the servers base url
* will automatically be prefixed.
*
- * @param bool $prefixBaseUrl
* @param array $privileges
+ * @param bool $prefixBaseUrl
*/
function __construct(array $privileges, $prefixBaseUrl = true) {
diff --git a/lib/DAVACL/Xml/Property/CurrentUserPrivilegeSet.php b/lib/DAVACL/Xml/Property/CurrentUserPrivilegeSet.php
index 7e4d792..0f87cbc 100644
--- a/lib/DAVACL/Xml/Property/CurrentUserPrivilegeSet.php
+++ b/lib/DAVACL/Xml/Property/CurrentUserPrivilegeSet.php
@@ -76,6 +76,7 @@ class CurrentUserPrivilegeSet implements Element, HtmlOutput {
* Returns true or false, whether the specified principal appears in the
* list.
*
+ * @param string $privilegeName
* @return bool
*/
function has($privilegeName) {
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-owncloud/php-sabredav.git
More information about the Pkg-owncloud-commits
mailing list