docs(lib/Utils): Add DocBlock for Oembed Util (#219)

flyntwp · Jun 12, 2017 · 2370364 · 2370364
1 parent 5709a65
commit 2370364
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/lib/Utils/Oembed.php b/lib/Utils/Oembed.php
@@ -6,6 +6,17 @@
 
 class Oembed
 {
+    /**
+     * Sets an oembed source as data attribute.
+     * Possibility to append query variables to the URL by using additional get parameters.
+     *
+     * @since %%NEXT_VERSION%%
+     *
+     * @param $iframeTagHtml string The oembed iframe HTML tag.
+     * @param $additionalGetParams array Associative array of key/values of additional query variables to append to the url.
+     *
+     * @return string The modified oembed iframe HTML tag.
+     */
     public static function setSrcAsDataAttribute($iframeTagHtml, $additionalGetParams)
     {
         $output = '';