Clearer PHPDocs comment for AbstractBlock::escapeJJsQuote and Escaper::escapeJsQuote

edward-simpson · edward-simpson · commit ab1d4d67cd3d · 2019-11-05T17:05:18.000Z
diff --git a/lib/internal/Magento/Framework/Escaper.php b/lib/internal/Magento/Framework/Escaper.php
@@ -310,7 +310,8 @@ public function escapeCss($string)
     }
 
     /**
-     * Escape quotes in java script
+     * Escape single quotes/apostrophes ('), or other specified $quote character
+     * in javascript (string or array of strings)
      *
      * @param string|array $data
      * @param string $quote
diff --git a/lib/internal/Magento/Framework/View/Element/AbstractBlock.php b/lib/internal/Magento/Framework/View/Element/AbstractBlock.php
@@ -985,10 +985,12 @@ public function escapeQuote($data, $addSlashes = false)
     }
 
     /**
-     * Escape quotes in java scripts
+     * Escape single quotes/apostrophes ('), or other specified $quote character
+     * in javascript (string or array of strings)
      *
      * @param string|array $data
      * @param string $quote
+     *
      * @return string|array
      * @deprecated 100.2.0
      */

Original file line number	Diff line number	Diff line change
`@@ -310,7 +310,8 @@ public function escapeCss($string)`
`310`	`310`	`}`
`311`	`311`
`312`	`312`	`/**`
`313`		`- * Escape quotes in java script`
	`313`	`+ * Escape single quotes/apostrophes ('), or other specified $quote character`
	`314`	`+ * in javascript (string or array of strings)`
`314`	`315`	`*`
`315`	`316`	`* @param string\|array $data`
`316`	`317`	`* @param string $quote`
Original file line number	Diff line number	Diff line change
`@@ -985,10 +985,12 @@ public function escapeQuote($data, $addSlashes = false)`
`985`	`985`	`}`
`986`	`986`
`987`	`987`	`/**`
`988`		`- * Escape quotes in java scripts`
	`988`	`+ * Escape single quotes/apostrophes ('), or other specified $quote character`
	`989`	`+ * in javascript (string or array of strings)`
`989`	`990`	`*`
`990`	`991`	`* @param string\|array $data`
`991`	`992`	`* @param string $quote`
	`993`	`+ *`
`992`	`994`	`* @return string\|array`
`993`	`995`	`* @deprecated 100.2.0`
`994`	`996`	`*/`