From 18ccd7842f1993f75b340d851839f134215eec03 Mon Sep 17 00:00:00 2001 From: kaldari Date: Wed, 25 Jun 2014 14:40:13 -0700 Subject: [PATCH] Adding and improving function and param descriptions in HtmlFormatter The change only includes documentation changes, no code changes. Change-Id: Ie1fdfcc774883882f50fd53d3cb32ade7f0bad34 --- includes/HtmlFormatter.php | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/includes/HtmlFormatter.php b/includes/HtmlFormatter.php index b2209c358e..38aa3922fd 100644 --- a/includes/HtmlFormatter.php +++ b/includes/HtmlFormatter.php @@ -314,9 +314,13 @@ class HtmlFormatter { } /** + * Helper function for parseItemsToRemove(). This function extracts the selector type + * and the raw name of a selector from a CSS-style selector string and assigns those + * values to parameters passed by reference. For example, if given '#toc' as the + * $selector parameter, it will assign 'ID' as the $type and 'toc' as the $rawName. * @param string $selector CSS selector to parse - * @param string $type - * @param string $rawName + * @param string $type The type of selector (ID, CLASS, TAG_CLASS, or TAG) + * @param string $rawName The raw name of the selector * @return bool Whether the selector was successfully recognised */ protected function parseSelector( $selector, &$type, &$rawName ) { @@ -340,7 +344,8 @@ class HtmlFormatter { } /** - * Transforms CSS selectors into an internal representation suitable for processing + * Transforms CSS-style selectors into an internal representation suitable for + * processing by filterContent() * @return array */ protected function parseItemsToRemove() { -- 2.20.1