h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2024-09-22 02:07:34 +08:00
Code Issues Releases Wiki Activity

Update xml doc

Browse Source
This commit is contained in:
Cootz 2023-02-17 15:23:43 +03:00
parent ceed3606cd
commit a3b440493a
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
osu.Game/Database/LegacyExporter.cs
View File

@ -24,9 +24,18 @@ namespace osu.Game.Database
/// Max length of filename (including extension).
/// </summary>
/// <remarks>
/// TODO: WHY? DOCUMENTATION PER PLATFORM LINKS HERE.
///
/// This actual usable length is smaller 256 because <see cref="Storage.CreateFileSafely(string)"/> adds additional "_<see cref="Guid"/>" to the end of the path
/// <para>
/// Filename limit for most OSs is 255, this actual usable length is smaller because <see cref="Storage.CreateFileSafely(string)"/> adds additional "_<see cref="Guid"/>" to the end of the path.
/// </para>
/// <para>
/// For more information see:
/// <br>
/// <see href="https://www.ibm.com/docs/en/spectrum-protect/8.1.9?topic=parameters-file-specification-syntax">File specification syntax</see>
/// </br>
/// <br>
/// <seealso href="https://en.wikipedia.org/wiki/Comparison_of_file_systems#Limits">File systems limitations</seealso>
/// </br>
/// </para>
/// </remarks>
public const int MAX_FILENAME_LENGTH = 255 - (32 + 4 + 2); //max path - (Guid + Guid "D" format chars + Storage.CreateFileSafely chars)