From: ayush_garg <ayush.ce13@iitp.ac.in>
Date: Thu, 5 Feb 2015 13:13:43 +0000 (+0530)
Subject: Documentation of compressOld.php
X-Git-Tag: 1.31.0-rc.0~12487^2
X-Git-Url: https://git.cyclocoop.org/%7B%24www_url%7Dadmin/compta/banques/%7B%7B%20url_for%28%27admin_users%27%29%20%7D%7D?a=commitdiff_plain;h=391d0f5e1cd016de186f15ead29c133944c69a1e;p=lhc%2Fweb%2Fwiklou.git

Documentation of compressOld.php

Change-Id: Ib6e4914379568bfae32007f6e76968791798b08f
---

diff --git a/maintenance/storage/compressOld.php b/maintenance/storage/compressOld.php
index cfffbbcae9..3cb4a2ba96 100644
--- a/maintenance/storage/compressOld.php
+++ b/maintenance/storage/compressOld.php
@@ -50,9 +50,15 @@ require_once __DIR__ . '/../Maintenance.php';
  */
 class CompressOld extends Maintenance {
 	/**
-	 * @todo document
+	 * Option to load each revision individually.
+	 *
 	 */
 	const LS_INDIVIDUAL = 0;
+
+	/**
+	 * Option to load revisions in chunks.
+	 *
+	 */
 	const LS_CHUNKED = 1;
 
 	public function __construct() {
@@ -137,7 +143,8 @@ class CompressOld extends Maintenance {
 	}
 
 	/**
-	 * @todo document
+	 * Fetch the text row-by-row to 'compressPage' function for compression.
+	 *
 	 * @param int $start
 	 * @param string $extdb
 	 */
@@ -172,7 +179,8 @@ class CompressOld extends Maintenance {
 	}
 
 	/**
-	 * @todo document
+	 * Compress the text in gzip format.
+	 *
 	 * @param stdClass $row
 	 * @param string $extdb
 	 * @return bool
@@ -214,6 +222,8 @@ class CompressOld extends Maintenance {
 	}
 
 	/**
+	 * Compress the text in chunks after concatenating the revisions.
+	 *
 	 * @param int $startId
 	 * @param int $maxChunkSize
 	 * @param string $beginDate