diff options
| author | Andrey Andreev <narf@devilix.net> | 2014-02-07 22:31:49 +0100 |
|---|---|---|
| committer | Andrey Andreev <narf@devilix.net> | 2014-02-07 22:31:49 +0100 |
| commit | 3de130c2da3b93a3404f264e92d7b65354de3548 (patch) | |
| tree | 368b1847fffe7af21c5fbc3fa7925212b678e60b /user_guide_src/source/helpers/xml_helper.rst | |
| parent | 1e584208e420d1d864de2bc686d437ecdf0ce064 (diff) | |
[ci skip] Add return types to helper docs (+ some other formatting)
Diffstat (limited to 'user_guide_src/source/helpers/xml_helper.rst')
| -rw-r--r-- | user_guide_src/source/helpers/xml_helper.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/user_guide_src/source/helpers/xml_helper.rst b/user_guide_src/source/helpers/xml_helper.rst index 7d155e192..a40ea9ad3 100644 --- a/user_guide_src/source/helpers/xml_helper.rst +++ b/user_guide_src/source/helpers/xml_helper.rst @@ -30,7 +30,8 @@ The following functions are available: :param string $str: the text string to convert :param bool $protect_all: Whether to protect all content that looks like a potential entity instead of just numbered entities, e.g. &foo; - :returns: string + :returns: XML-converted string + :rtype: string Takes a string as input and converts the following reserved XML characters to entities: @@ -51,4 +52,4 @@ The following functions are available: .. code-block:: html - <p>Here is a paragraph & an entity ({).</p> + <p>Here is a paragraph & an entity ({).</p>
\ No newline at end of file |