From: Kaldari <rkaldari@wikimedia.org>
Date: Fri, 15 Jul 2016 05:05:02 +0000 (-0700)
Subject: Improving some function documentation in CategoryViewer.php
X-Git-Tag: 1.31.0-rc.0~6355^2
X-Git-Url: https://git.cyclocoop.org/%7B%24www_url%7Dadmin/compta/comptes/ajouter.php?a=commitdiff_plain;h=3f9c5710c8328e0faf8942950c8128013a11e567;p=lhc%2Fweb%2Fwiklou.git

Improving some function documentation in CategoryViewer.php

Change-Id: Ic4ad35d95aa157db627ef9b213007691f465c260
---

diff --git a/includes/CategoryViewer.php b/includes/CategoryViewer.php
index 389b077474..8dd3f5c516 100644
--- a/includes/CategoryViewer.php
+++ b/includes/CategoryViewer.php
@@ -532,17 +532,17 @@ class CategoryViewer extends ContextSource {
 	}
 
 	/**
-	 * Format a list of articles chunked by letter in a three-column
-	 * list, ordered vertically.
+	 * Format a list of articles chunked by letter in a three-column list, ordered
+	 * vertically. This is used for categories with a significant number of pages.
 	 *
 	 * TODO: Take the headers into account when creating columns, so they're
 	 * more visually equal.
 	 *
 	 * TODO: shortList and columnList are similar, need merging
 	 *
-	 * @param array $articles
-	 * @param string[] $articles_start_char
-	 * @return string
+	 * @param string[] $articles HTML links to each article
+	 * @param string[] $articles_start_char The header characters for each article
+	 * @return string HTML to output
 	 * @private
 	 */
 	static function columnList( $articles, $articles_start_char ) {
@@ -579,10 +579,11 @@ class CategoryViewer extends ContextSource {
 	}
 
 	/**
-	 * Format a list of articles chunked by letter in a bullet list.
-	 * @param array $articles
-	 * @param string[] $articles_start_char
-	 * @return string
+	 * Format a list of articles chunked by letter in a bullet list. This is used
+	 * for categories with a small number of pages (when columns aren't needed).
+	 * @param string[] $articles HTML links to each article
+	 * @param string[] $articles_start_char The header characters for each article
+	 * @return string HTML to output
 	 * @private
 	 */
 	static function shortList( $articles, $articles_start_char ) {