summaryrefslogtreecommitdiffstats
path: root/user_guide_src/source/libraries/parser.rst
diff options
context:
space:
mode:
authorAndrey Andreev <narf@devilix.net>2014-02-08 03:27:48 +0100
committerAndrey Andreev <narf@devilix.net>2014-02-08 03:27:48 +0100
commit28c2c975b118016d07212ed8e7c22ff280309f82 (patch)
treef1552392a3d87efebd7c565c6414ae41dc208ee9 /user_guide_src/source/libraries/parser.rst
parent9228f85b1b4f59cc88ba7c4addc258a7a5fd0ac0 (diff)
[ci skip] Add return types to library docs
Diffstat (limited to 'user_guide_src/source/libraries/parser.rst')
-rw-r--r--user_guide_src/source/libraries/parser.rst24
1 files changed, 13 insertions, 11 deletions
diff --git a/user_guide_src/source/libraries/parser.rst b/user_guide_src/source/libraries/parser.rst
index 34ad65f2b..5af504a03 100644
--- a/user_guide_src/source/libraries/parser.rst
+++ b/user_guide_src/source/libraries/parser.rst
@@ -151,27 +151,29 @@ Class Reference
.. method:: parse($template, $data[, $return = FALSE])
- :param string $template: Path to view file
- :param array $data: Variable data
- :param bool $return: Whether to return the parsed template
- :returns: mixed
+ :param string $template: Path to view file
+ :param array $data: Variable data
+ :param bool $return: Whether to only return the parsed template
+ :returns: Parsed template string
+ :rtype: string
Parses a template from the provided path and variables.
.. method:: parse_string($template, $data[, $return = FALSE])
- :param string $template: Path to view file
- :param array $data: Variable data
- :param bool $return: Whether to return the parsed template
- :returns: mixed
+ :param string $template: Path to view file
+ :param array $data: Variable data
+ :param bool $return: Whether to only return the parsed template
+ :returns: Parsed template string
+ :rtype: string
This method works exactly like ``parse()``, only it accepts the template as a
string instead of loading a view file.
.. method:: set_delimiters([$l = '{'[, $r = '}']])
- :param string $l: Left delimiter
- :param string $r: Right delimiter
- :returns: void
+ :param string $l: Left delimiter
+ :param string $r: Right delimiter
+ :rtype: void
Sets the delimiters (opening and closing) for a value "tag" in a template. \ No newline at end of file