From b0d659bb2182906f0df12e0213f50e75449d0488 Mon Sep 17 00:00:00 2001 From: Sam Reed Date: Sat, 25 Jun 2011 16:15:44 +0000 Subject: [PATCH] Uncommited documentation from my working copy --- includes/Export.php | 8 +++++++- includes/filerepo/File.php | 4 +++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/includes/Export.php b/includes/Export.php index 0dbba91876..8a3d7df262 100644 --- a/includes/Export.php +++ b/includes/Export.php @@ -438,12 +438,13 @@ class XmlDumpWriter { /** * Closes the output stream with the closing root element. * Call when finished dumping things. + * + * @return string */ function closeStream() { return "\n"; } - /** * Opens a section on the output stream, with data * from the given database row. @@ -616,6 +617,11 @@ class XmlDumpWriter { return ''; } + /** + * @param $file File + * @param $dumpContents bool + * @return string + */ function writeUpload( $file, $dumpContents = false ) { if ( $file->isOld() ) { $archiveName = " " . diff --git a/includes/filerepo/File.php b/includes/filerepo/File.php index 5859cc92ec..e1f89b8b04 100644 --- a/includes/filerepo/File.php +++ b/includes/filerepo/File.php @@ -1431,7 +1431,9 @@ abstract class File { * 160 log 2 / log 36 = 30.95, so the 160-bit hash fills 31 digits in base 36 * fairly neatly. * - * Returns false on failure + * @param $path string + * + * @return false on failure * * @param $path string * -- 2.20.1