tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

Requirements.php API documentation fix

Browse Source 
The API documentation for Requirements is currently broken:
https://api.silverstripe.org/4/SilverStripe/View/Requirements.html#method_customScript

This is because there are unescaped start tags in the function documentation. 

This fix changes the tags to be escaped.
This commit is contained in:
3Dgoo 2019-06-13 09:21:12 +09:30 committed by GitHub
parent 4eb5800532
commit 8dcfa53109
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/View/Requirements.php
View File

@ -135,7 +135,7 @@ class Requirements implements Flushable
/** /**
* Register the given JavaScript code into the list of requirements * Register the given JavaScript code into the list of requirements
* *
* @param string $script The script content as a string (without enclosing <script> tag) * @param string $script The script content as a string (without enclosing `<script>` tag)
* @param string|int $uniquenessID A unique ID that ensures a piece of code is only added once * @param string|int $uniquenessID A unique ID that ensures a piece of code is only added once
*/ */
public static function customScript($script, $uniquenessID = null) public static function customScript($script, $uniquenessID = null)
@ -156,7 +156,7 @@ class Requirements implements Flushable
/** /**
* Register the given CSS styles into the list of requirements * Register the given CSS styles into the list of requirements
* *
* @param string $script CSS selectors as a string (without enclosing <style> tag) * @param string $script CSS selectors as a string (without enclosing `<style>` tag)
* @param string|int $uniquenessID A unique ID that ensures a piece of code is only added once * @param string|int $uniquenessID A unique ID that ensures a piece of code is only added once
*/ */
public static function customCSS($script, $uniquenessID = null) public static function customCSS($script, $uniquenessID = null)
@ -165,7 +165,7 @@ class Requirements implements Flushable
} }
/** /**
* Add the following custom HTML code to the <head> section of the page * Add the following custom HTML code to the `<head>` section of the page
* *
* @param string $html Custom HTML code * @param string $html Custom HTML code
* @param string|int $uniquenessID A unique ID that ensures a piece of code is only added once * @param string|int $uniquenessID A unique ID that ensures a piece of code is only added once