diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2022-02-22 20:06:07 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-22 20:06:07 +0100 |
| commit | e0d18071a60fd40d5256f184167673dfa1e468c8 (patch) | |
| tree | 6604a9de86408aacb4f4890c9f1757f8b7f25d35 /doc/classes | |
| parent | 872e8a43ca08920c8d3d82a20265742ac7186a66 (diff) | |
| parent | b2b2e0606f10e4544a7721f71529707eeb584eef (diff) | |
Merge pull request #58442 from novaplusplus/docs-string-humanize-size
Document String's humanize_size static method
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/String.xml | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/classes/String.xml b/doc/classes/String.xml index 4ff2d287a1..5f133169f2 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -265,6 +265,8 @@ <return type="String" /> <argument index="0" name="size" type="int" /> <description> + Converts an integer representing a number of bytes into a human-readable form. + Note that this output is in [url=https://en.wikipedia.org/wiki/Binary_prefix#IEC_prefixes]IEC prefix format[/url], and includes [code]B[/code], [code]KiB[/code], [code]MiB[/code], [code]GiB[/code], [code]TiB[/code], [code]PiB[/code], and [code]EiB[/code]. </description> </method> <method name="indent" qualifiers="const"> |