c689fd2e4c
* "@example" is specifically for creating entries on the "Examples" page produced by Doxygen, which is not specific to individual classes or methods, but rather is meant to be about the software as a whole. There are currently four entries produced there, and they are all broken: - .../src/includes/rcfeed/RedisPubSubFeedEngine.php (unnamed example, broken) - .../src/tests/phpunit/MediaWikiTestCase.php (unnamed example) - 42 (empty page named "42") - user (empty page named "user") * Remove usage and replace with either a regular paragraph that is part of the member/method/class description, or for code examples, use "@par" to create a sub heading, and then a @code-@endcode block. Change-Id: I52c937fef4b377173f6c4dbad9dc4a9f8beae4ee
45 lines
1.4 KiB
PHP
45 lines
1.4 KiB
PHP
<?php
|
|
/**
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
/**
|
|
* A wrapper class which causes Xml::encodeJsVar() and Xml::encodeJsCall() to
|
|
* interpret a given string as being a JavaScript expression, instead of string
|
|
* data.
|
|
*
|
|
* @par Example:
|
|
* @code
|
|
* Xml::encodeJsVar( new XmlJsCode( 'a + b' ) );
|
|
* @encode
|
|
*
|
|
* This returns "a + b".
|
|
*
|
|
* @note As of 1.21, XmlJsCode objects cannot be nested inside objects or arrays. The sole
|
|
* exception is the $args argument to Xml::encodeJsCall() because Xml::encodeJsVar() is
|
|
* called for each individual element in that array.
|
|
*
|
|
* @since 1.17
|
|
*/
|
|
class XmlJsCode {
|
|
public $value;
|
|
|
|
function __construct( $value ) {
|
|
$this->value = $value;
|
|
}
|
|
}
|