https://www.mediawiki.org/wiki/Special:Code/MediaWiki/107122
Revision: 107122
Author: aaron
Date: 2011-12-22 23:18:57 +0000 (Thu, 22 Dec 2011)
Log Message:
-----------
Documentation fixes
Modified Paths:
--------------
trunk/phase3/includes/filerepo/backend/FileBackend.php
Modified: trunk/phase3/includes/filerepo/backend/FileBackend.php
===================================================================
--- trunk/phase3/includes/filerepo/backend/FileBackend.php 2011-12-22
23:12:44 UTC (rev 107121)
+++ trunk/phase3/includes/filerepo/backend/FileBackend.php 2011-12-22
23:18:57 UTC (rev 107122)
@@ -406,7 +406,7 @@
* Callers should consider using getScopedFileLocks() instead.
*
* @param $paths Array Storage paths
- * @param $type integer LockManager::LOCK_EX, LockManager::LOCK_SH
+ * @param $type integer LockManager::LOCK_* constant
* @return Status
*/
final public function lockFiles( array $paths, $type ) {
@@ -417,7 +417,7 @@
* Unlock the files at the given storage paths in the backend.
*
* @param $paths Array Storage paths
- * @param $type integer LockManager::LOCK_EX, LockManager::LOCK_SH
+ * @param $type integer LockManager::LOCK_* constant
* @return Status
*/
final public function unlockFiles( array $paths, $type ) {
@@ -433,7 +433,7 @@
* the status updated. Unlock fatals will not change the status "OK"
value.
*
* @param $paths Array Storage paths
- * @param $type integer LockManager::LOCK_EX, LockManager::LOCK_SH
+ * @param $type integer LockManager::LOCK_* constant
* @param $status Status Status to update on lock/unlock
* @return ScopedLock|null Returns null on failure
*/
@@ -460,7 +460,7 @@
* $params include:
* src : source path on disk
* dst : destination storage path
- * overwriteDest : do nothing and pass if an identical file exists
at destination
+ * overwriteDest : overwrite any file that exists at the destination
*
* @param $params Array
* @return Status
@@ -482,7 +482,7 @@
* $params include:
* src : source storage path
* dst : destination storage path
- * overwriteDest : do nothing and pass if an identical file exists
at destination
+ * overwriteDest : overwrite any file that exists at the destination
*
* @param $params Array
* @return Status
@@ -502,7 +502,8 @@
* Delete a file at the storage path.
* Do not call this function from places outside FileBackend and FileOp.
* $params include:
- * src : source storage path
+ * src : source storage path
+ * ignoreMissingSource : do nothing if the source file does not
exist
*
* @param $params Array
* @return Status
@@ -524,7 +525,7 @@
* $params include:
* src : source storage path
* dst : destination storage path
- * overwriteDest : do nothing and pass if an identical file exists
at destination
+ * overwriteDest : overwrite any file that exists at the destination
*
* @param $params Array
* @return Status
@@ -556,7 +557,7 @@
* $params include:
* srcs : ordered source storage paths (e.g. chunk1,
chunk2, ...)
* dst : destination storage path
- * overwriteDest : do nothing and pass if an identical file exists
at destination
+ * overwriteDest : overwrite any file that exists at the destination
*
* @param $params Array
* @return Status
@@ -578,7 +579,7 @@
* $params include:
* content : the raw file contents
* dst : destination storage path
- * overwriteDest : do nothing and pass if an identical file exists
at destination
+ * overwriteDest : overwrite any file that exists at the destination
*
* @param $params Array
* @return Status
_______________________________________________
MediaWiki-CVS mailing list
MediaWiki-CVS@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
