Author: ts
Date: Tue Dec 4 22:29:46 2007
New Revision: 6926
Log:
- Doc updates.
# Found by docanalysis tool.
Modified:
trunk/Webdav/design/class_diagram.png
trunk/Webdav/src/backends/file.php
trunk/Webdav/src/backends/memory.php
trunk/Webdav/src/backends/simple.php
trunk/Webdav/src/interfaces/backend.php
trunk/Webdav/src/interfaces/infrastructure_base.php
trunk/Webdav/src/interfaces/property_storage.php
trunk/Webdav/src/plugin_parameters.php
trunk/Webdav/src/properties/getcontentlanguage.php
trunk/Webdav/src/properties/getcontenttype.php
trunk/Webdav/src/property_storages/basic.php
trunk/Webdav/src/requests/content/lock_info.php
trunk/Webdav/src/responses/propstat.php
trunk/Webdav/src/server.php
trunk/Webdav/src/server_configuration.php
trunk/Webdav/src/server_configuration_manager.php
trunk/Webdav/src/tools/xml.php
trunk/Webdav/src/transport.php
trunk/Webdav/src/transports/property_handler.php
Modified: trunk/Webdav/design/class_diagram.png
==============================================================================
Binary files - no diff available.
Modified: trunk/Webdav/src/backends/file.php
==============================================================================
--- trunk/Webdav/src/backends/file.php [iso-8859-1] (original)
+++ trunk/Webdav/src/backends/file.php [iso-8859-1] Tue Dec 4 22:29:46 2007
@@ -73,7 +73,7 @@
* identified by $root. If the given path does not exist or is not a
* directory, an exception will be thrown.
*
- * @param string $path
+ * @param string $root
* @return void
*
* @throws ezcBaseFileNotFoundException
@@ -103,7 +103,7 @@
*
* @throws ezcBasePropertyNotFoundException
* If a the value for the property propertys is not an instance of
- * @param string $propertyName The name of the property to get.
+ * @param string $name The name of the property to get.
* @return mixed The property value.
*
* @ignore
@@ -129,8 +129,8 @@
* Sets a property.
* This method is called when an property is to be set.
*
- * @param string $propertyName The name of the property to set.
- * @param mixed $propertyValue The property value.
+ * @param string $name The name of the property to set.
+ * @param mixed $value The property value.
* @ignore
*
* @throws ezcBasePropertyNotFoundException
@@ -512,7 +512,7 @@
* identified by $path and replaces it with the given $properties.
*
* @param string $path
- * @param ezcWebdavPropertyStorage $properties
+ * @param ezcWebdavPropertyStorage $storage
* @return bool
*/
public function resetProperties( $path, ezcWebdavPropertyStorage $storage )
@@ -948,7 +948,7 @@
* [EMAIL PROTECTED] ezcWebdavSimpleBackend} to perform the operation and
releases the
* lock afterwards.
*
- * @param ezcWebdavGetRequest $request
+ * @param ezcWebdavHeadRequest $request
* @return ezcWebdavResponse
*/
public function head( ezcWebdavHeadRequest $request )
Modified: trunk/Webdav/src/backends/memory.php
==============================================================================
--- trunk/Webdav/src/backends/memory.php [iso-8859-1] (original)
+++ trunk/Webdav/src/backends/memory.php [iso-8859-1] Tue Dec 4 22:29:46 2007
@@ -88,7 +88,7 @@
/**
* Construct backend from a given path.
*
- * @param string $path
+ * @param bool $fakeLiveProperties
* @return void
*/
public function __construct( $fakeLiveProperties = true )
@@ -234,6 +234,7 @@
* storage.
*
* @param array $contents
+ * @param string $path
* @return void
*/
public function addContents( array $contents, $path = '/' )
Modified: trunk/Webdav/src/backends/simple.php
==============================================================================
--- trunk/Webdav/src/backends/simple.php [iso-8859-1] (original)
+++ trunk/Webdav/src/backends/simple.php [iso-8859-1] Tue Dec 4 22:29:46 2007
@@ -272,7 +272,7 @@
* ezcWebdavErrorResponse} instance on error or an instance of [EMAIL
PROTECTED]
* ezcWebdavHeadResponse} on success.
*
- * @param ezcWebdavGetRequest $request
+ * @param ezcWebdavHeadRequest $request
* @return ezcWebdavResponse
*/
public function head( ezcWebdavHeadRequest $request )
Modified: trunk/Webdav/src/interfaces/backend.php
==============================================================================
--- trunk/Webdav/src/interfaces/backend.php [iso-8859-1] (original)
+++ trunk/Webdav/src/interfaces/backend.php [iso-8859-1] Tue Dec 4 22:29:46
2007
@@ -189,7 +189,7 @@
* ezcWebdavErrorResponse} instance on error or an instance of [EMAIL
PROTECTED]
* ezcWebdavHeadResponse} on success.
*
- * @param ezcWebdavGetRequest $request
+ * @param ezcWebdavHeadRequest $request
* @return ezcWebdavResponse
*/
abstract public function head( ezcWebdavHeadRequest $request );
Modified: trunk/Webdav/src/interfaces/infrastructure_base.php
==============================================================================
--- trunk/Webdav/src/interfaces/infrastructure_base.php [iso-8859-1] (original)
+++ trunk/Webdav/src/interfaces/infrastructure_base.php [iso-8859-1] Tue Dec 4
22:29:46 2007
@@ -25,12 +25,12 @@
* $this->removePluginData()}. A check if data is available for a given plugin
* namespace and key can be checked using [EMAIL PROTECTED]
$this->hasPluginData()}.
*
+ * NOTE: The plugin API is not public, yet, and will be released in a later
+ * version of this component.
+ *
* @see ezcWebdavRequest
* @see ezcWebdavResponse
* @see ezcWebdavProperty
- *
- * NOTE: The plugin API is not public, yet, and will be released in a later
- * version of this component.
*
* @package Webdav
* @version //autogen//
Modified: trunk/Webdav/src/interfaces/property_storage.php
==============================================================================
--- trunk/Webdav/src/interfaces/property_storage.php [iso-8859-1] (original)
+++ trunk/Webdav/src/interfaces/property_storage.php [iso-8859-1] Tue Dec 4
22:29:46 2007
@@ -95,6 +95,7 @@
* be accessed by simply ommiting the $namespace parameter, since then the
* default namespace for live properties ('DAV:') is used.
*
+ * @param string $namespace
* @return array(string=>ezcWebdavProperty)
*/
public function getProperties( $namespace = 'DAV:' );
@@ -114,7 +115,7 @@
* Returns a property storage, which does only contain properties that are
* not present in the $properties parameter.
*
- * @param ezcWebdavBasicPropertyStorage $properties
+ * @param ezcWebdavPropertyStorage $properties
* @return ezcWebdavBasicPropertyStorage
*/
public function diff( ezcWebdavPropertyStorage $properties );
@@ -128,7 +129,7 @@
* which contains all values, which are present in the current and the
* given $properties property storage.
*
- * @param ezcWebdavBasicPropertyStorage $properties
+ * @param ezcWebdavPropertyStorage $properties
* @return ezcWebdavBasicPropertyStorage
*/
public function intersect( ezcWebdavPropertyStorage $properties );
Modified: trunk/Webdav/src/plugin_parameters.php
==============================================================================
--- trunk/Webdav/src/plugin_parameters.php [iso-8859-1] (original)
+++ trunk/Webdav/src/plugin_parameters.php [iso-8859-1] Tue Dec 4 22:29:46 2007
@@ -28,6 +28,7 @@
/**
* Create a new paramater storage.
*
+ * @param array $data
* @return void
*/
public function __construct( array $data = null )
Modified: trunk/Webdav/src/properties/getcontentlanguage.php
==============================================================================
--- trunk/Webdav/src/properties/getcontentlanguage.php [iso-8859-1] (original)
+++ trunk/Webdav/src/properties/getcontentlanguage.php [iso-8859-1] Tue Dec 4
22:29:46 2007
@@ -23,7 +23,7 @@
*
* The given array must contain strings that represent language shortcuts.
*
- * @param string $languages The languages.
+ * @param array(string) $languages
* @return void
*/
public function __construct( array $languages = array() )
Modified: trunk/Webdav/src/properties/getcontenttype.php
==============================================================================
--- trunk/Webdav/src/properties/getcontenttype.php [iso-8859-1] (original)
+++ trunk/Webdav/src/properties/getcontenttype.php [iso-8859-1] Tue Dec 4
22:29:46 2007
@@ -26,7 +26,8 @@
* The $mime must be a string representing a valid MIME type (e.g.
* 'text/plain'). An optional characterset can be defined (e.g. 'UTF-8').
*
- * @param string $mime The mime.
+ * @param string $mime
+ * @param string $charset
* @return void
*/
public function __construct( $mime = null, $charset = null )
Modified: trunk/Webdav/src/property_storages/basic.php
==============================================================================
--- trunk/Webdav/src/property_storages/basic.php [iso-8859-1] (original)
+++ trunk/Webdav/src/property_storages/basic.php [iso-8859-1] Tue Dec 4
22:29:46 2007
@@ -158,6 +158,7 @@
* be accessed by simply ommiting the $namespace parameter, since then the
* default namespace for live properties ('DAV:') is used.
*
+ * @param string $namespace
* @return array(string=>ezcWebdavProperty)
*/
public function getProperties( $namespace = 'DAV:' )
@@ -187,7 +188,7 @@
* Returns a property storage, which does only contain properties that are
* not present in the $properties parameter.
*
- * @param ezcWebdavBasicPropertyStorage $properties
+ * @param ezcWebdavPropertyStorage $properties
* @return ezcWebdavBasicPropertyStorage
*/
public function diff( ezcWebdavPropertyStorage $properties )
@@ -220,7 +221,7 @@
* which contains all values, which are present in the current and the
* given $properties property storage.
*
- * @param ezcWebdavBasicPropertyStorage $properties
+ * @param ezcWebdavPropertyStorage $properties
* @return ezcWebdavBasicPropertyStorage
*/
public function intersect( ezcWebdavPropertyStorage $properties )
Modified: trunk/Webdav/src/requests/content/lock_info.php
==============================================================================
--- trunk/Webdav/src/requests/content/lock_info.php [iso-8859-1] (original)
+++ trunk/Webdav/src/requests/content/lock_info.php [iso-8859-1] Tue Dec 4
22:29:46 2007
@@ -38,6 +38,9 @@
/**
* Creates a new instance.
*
+ * @param int $lockScope
+ * @param int $lockType
+ * @param string $owner
* @return void
*/
public function __construct( $lockScope, $lockType, $owner = null )
Modified: trunk/Webdav/src/responses/propstat.php
==============================================================================
--- trunk/Webdav/src/responses/propstat.php [iso-8859-1] (original)
+++ trunk/Webdav/src/responses/propstat.php [iso-8859-1] Tue Dec 4 22:29:46
2007
@@ -28,7 +28,7 @@
* ezcWebdavPropFindResponse} from a property storage ($storage) and
* optionally an error stutus code, which will default to 200(OK).
*
- * @param ezcWebdavPropertyStorage $properties
+ * @param ezcWebdavPropertyStorage $storage
* @param int $status
* @return void
*/
Modified: trunk/Webdav/src/server.php
==============================================================================
--- trunk/Webdav/src/server.php [iso-8859-1] (original)
+++ trunk/Webdav/src/server.php [iso-8859-1] Tue Dec 4 22:29:46 2007
@@ -43,9 +43,9 @@
* $server->handle( $backend );
* </code>
*
- * @properties ezcWebdavServerConfigurationManager $configurations
- * Webdav server configuration manager, which holds and dispatches
- * configurations that fit for a certain client.
+ * @property ezcWebdavServerConfigurationManager $configurations
+ * Webdav server configuration manager, which holds and dispatches
+ * configurations that fit for a certain client.
*
* @version //autogentag//
* @package Webdav
@@ -192,6 +192,7 @@
* @param ezcWebdavPathFactory $pathFactory
* @param ezcWebdavXmlTool $xmlTool
* @param ezcWebdavPropertyHandler $propertyHandler
+ * @param ezcWebdavHeaderHandler $headerHandler
* @param ezcWebdavTransport $transport
* @access protected
* @return void
Modified: trunk/Webdav/src/server_configuration.php
==============================================================================
--- trunk/Webdav/src/server_configuration.php [iso-8859-1] (original)
+++ trunk/Webdav/src/server_configuration.php [iso-8859-1] Tue Dec 4 22:29:46
2007
@@ -97,6 +97,7 @@
* @param string $transportClass
* @param string $xmlToolClass
* @param string $propertyHandlerClass
+ * @param string $headerHandlerClass
* @param ezcWebdavPathFactory $pathFactory
* @return void
*/
@@ -202,8 +203,8 @@
* if the property $name is not defined
* @throws ezcBaseValueException
* if $value is not correct for the property $name
- * @param string $name
- * @param mixed $value
+ * @param string $propertyName
+ * @param mixed $propertyValue
* @ignore
*/
public function __set( $propertyName, $propertyValue )
Modified: trunk/Webdav/src/server_configuration_manager.php
==============================================================================
--- trunk/Webdav/src/server_configuration_manager.php [iso-8859-1] (original)
+++ trunk/Webdav/src/server_configuration_manager.php [iso-8859-1] Tue Dec 4
22:29:46 2007
@@ -113,6 +113,7 @@
* has been removed or manipulated incorrectly, an [EMAIL PROTECTED]
* ezcWebdavMissingTransportConfigurationException} might be thrown.
*
+ * @param ezcWebdavServer $server
* @param mixed $userAgent
* @return void
*
Modified: trunk/Webdav/src/tools/xml.php
==============================================================================
--- trunk/Webdav/src/tools/xml.php [iso-8859-1] (original)
+++ trunk/Webdav/src/tools/xml.php [iso-8859-1] Tue Dec 4 22:29:46 2007
@@ -20,9 +20,9 @@
* [EMAIL PROTECTED] ezcWebdacServerConfigurationManager} instance, located in
the [EMAIL PROTECTED]
* ezcWebdacServer} singleton instance.
*
- * @properties ezcWebdavNamespaceRegistry $namespaceRegistry
- * Registry class that keeps track of used namespace URIs and their
- * abbreviations.
+ * @property ezcWebdavNamespaceRegistry $namespaceRegistry
+ * Registry class that keeps track of used namespace URIs and their
+ * abbreviations.
*
* @package Webdav
* @version //autogen//
@@ -77,10 +77,9 @@
* and loads the optionally given $xml string with settings appropriate to
* work with it. Returns false if the loading fails.
*
+ * @param sting $content
+ * @return DOMDocument|false
* @see LIBXML_NOWARNING, LIBXML_NSCLEAN, LIBXML_NOBLANKS
- *
- * @param sting $xml
- * @return DOMDocument|false
*/
public function createDomDocument( $content = null )
{
Modified: trunk/Webdav/src/transport.php
==============================================================================
--- trunk/Webdav/src/transport.php [iso-8859-1] (original)
+++ trunk/Webdav/src/transport.php [iso-8859-1] Tue Dec 4 22:29:46 2007
@@ -63,7 +63,7 @@
* <li>[EMAIL PROTECTED] ezcWebdavHeadResponse}</li>
* <li>[EMAIL PROTECTED] ezcWebdavMakeCollectionResponse}</li>
* <li>[EMAIL PROTECTED] ezcWebdavMoveResponse}</li>
- * <li>[EMAIL PROTECTED] ezcWebdavMultistatusResponse}</li>
+ * <li>[EMAIL PROTECTED] ezcWebdavMultiStatusResponse}</li>
* <li>[EMAIL PROTECTED] ezcWebdavOptionsResponse}</li>
* <li>[EMAIL PROTECTED] ezcWebdavPropFindResponse}</li>
* <li>[EMAIL PROTECTED] ezcWebdavPropPatchResponse}</li>
@@ -74,10 +74,9 @@
* @see ezcWebdavResponse
* @see ezcWebdavProperty
*
- * @link http://tools.ietf.org/html/rfc2518 RFC 2518
- *
* @version //autogentag//
* @package Webdav
+ * @link http://tools.ietf.org/html/rfc2518 RFC 2518
*/
class ezcWebdavTransport
{
@@ -167,6 +166,7 @@
* ezcWebdavResponse} may be returned instead of an instance of [EMAIL
PROTECTED]
* ezcWebdavRequest}. [EMAIL PROTECTED] ezcWebdavServer} will handle this
correctly.
*
+ * @param string $uri
* @return ezcWebdavRequest|ezcWebdavResponse
*/
public final function parseRequest( $uri )
Modified: trunk/Webdav/src/transports/property_handler.php
==============================================================================
--- trunk/Webdav/src/transports/property_handler.php [iso-8859-1] (original)
+++ trunk/Webdav/src/transports/property_handler.php [iso-8859-1] Tue Dec 4
22:29:46 2007
@@ -103,7 +103,7 @@
* ezcWebdavFlaggedPropertyStorage->attach()}.
*
* @param DOMNodeList $domNodes
- * @param ezcWebdavPropertyStorage $storage
+ * @param ezcWebdavBasicPropertyStorage $storage
* @param int $flag
* @return ezcWebdavBasicPropertyStorage
*/
@@ -358,12 +358,12 @@
}
/**
- * Serializes an object of new ezcWebdavBasicPropertyStorage to XML.
+ * Serializes an object of new ezcWebdavPropertyStorage to XML.
*
* Attaches all properties of the $storage to the $parentElement XML
* element in their XML representation.
*
- * @param new ezcWebdavPropertyStorage $storage
+ * @param ezcWebdavPropertyStorage $storage
* @param DOMElement $parentElement
* @return void
*/
--
svn-components mailing list
svn-components@lists.ez.no
http://lists.ez.no/mailman/listinfo/svn-components
