Make beautifyFileSize public

[juuz0]

Requirement for kiwix/kiwix-desktop#946

[codecov]

Codecov Report

Patch and project coverage have no change.

Comparison is base (cb74c9c) 38.87% compared to head (5c3a997) 38.87%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #971   +/-   ##
=======================================
  Coverage   38.87%   38.87%           
=======================================
  Files          56       56           
  Lines        3974     3974           
  Branches     2187     2187           
=======================================
  Hits         1545     1545           
  Misses       1097     1097           
  Partials     1332     1332           

Impacted Files	Coverage Δ
src/tools/stringTools.h	30.00% <ø> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[kelson42]

@juuz0 Not sure this function is documented properly (in readtjedocs), please add the necessary documentation.

[mgautierfr]

Not sure this function is documented properly (in readtjedocs), please add the necessary documentation.

It will be documented this way : https://libkiwix--971.org.readthedocs.build/en/971/api/function_tools_8h_1a18e272a0e35c09646b78f566e92ac292.html

[kelson42]

@mgautierfr actually not bad. LGTM if the number given is not expected to be in a specific unity (bytes for example)... because this is not written in the doc.

[mgautierfr]

The name of the function is beautifyFileSize so yes, we expect a size and so the unit is B/KB/MB/GB

[kelson42]

@mgautierfr If the result is given with a unity, then the unity of the input expected should be specified in the documentaiton. Here I guess Bytes. Otherwise, all good.

[juuz0]

@kelson42 updated the description