From 3f9c5710c8328e0faf8942950c8128013a11e567 Mon Sep 17 00:00:00 2001 From: Kaldari Date: Thu, 14 Jul 2016 22:05:02 -0700 Subject: [PATCH] Improving some function documentation in CategoryViewer.php Change-Id: Ic4ad35d95aa157db627ef9b213007691f465c260 --- includes/CategoryViewer.php | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) 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 ) { -- 2.20.1