From 185acb4d2a29870b478e166bfa2d18a16c012351 Mon Sep 17 00:00:00 2001 From: Andy Miller Date: Thu, 6 Oct 2016 11:35:48 -0600 Subject: [PATCH] updated some docblocks --- system/src/Grav/Common/Utils.php | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/system/src/Grav/Common/Utils.php b/system/src/Grav/Common/Utils.php index cd20a43ef..3c8a9f607 100644 --- a/system/src/Grav/Common/Utils.php +++ b/system/src/Grav/Common/Utils.php @@ -430,11 +430,11 @@ abstract class Utils } /** - * Process a Grav image media URL from HTML tag + * Process Grav image media URL from HTML tag * - * @param $html HTML tag e.g. `` - * @param $page - * @return string + * @param $html HTML tag e.g. `` + * @param $page The current page object + * @return string Returns final HTML string */ public static function processImageHtml($html, $page) { @@ -445,6 +445,13 @@ abstract class Utils return $html; } + /** + * Get an Excerpt array from a chunk of HTML + * + * @param $html Chunk of HTML + * @param $tag a tag, for example `img` + * @return array|null returns nested array excerpt + */ public static function getExcerptFromHtml($html, $tag) { $doc = new \DOMDocument();