Skip to content

Commit

Permalink
Fix usage of USDX_VERSION in comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
bohning committed May 27, 2024
1 parent 9ad8f7c commit 80adde2
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions src/base/UPlatformMacOSX.pas
Original file line number Diff line number Diff line change
Expand Up @@ -73,29 +73,29 @@ interface
*
* So
* GetGameSharedPath could return
* /Library/Application Support/UltraStarDeluxe_{USDX_VERSION}/.
* /Library/Application Support/UltraStarDeluxe_[USDX_VERSION]/.
* GetGameUserPath could return
* ~/Library/Application Support/UltraStarDeluxe_{USDX_VERSION}/.
* ~/Library/Application Support/UltraStarDeluxe_[USDX_VERSION]/.
*
* Right now, only $HOME/Library/Application Support/UltraStarDeluxe_{USDX_VERSION}
* Right now, only $HOME/Library/Application Support/UltraStarDeluxe_[USDX_VERSION]
* is used. So every user needs the complete set of files and folders.
* Future versions may also use shared resources in
* /Library/Application Support/UltraStarDeluxe_{USDX_VERSION}. However, this is
* /Library/Application Support/UltraStarDeluxe_[USDX_VERSION]. However, this is
* not treated yet in the code outside this unit.
*
* USDX checks, whether GetGameUserPath exists. If not, USDX creates it.
* The existence of needed files is then checked and if a file is missing
* it is copied to there from within the folder Contents in the Application
* bundle, which contains the default files. USDX should not delete files or
* folders in Application Support/UltraStarDeluxe_{USDX_VERSION} automatically or without
* folders in Application Support/UltraStarDeluxe_[USDX_VERSION] automatically or without
* user confirmation.
*
* The log and benchmark files are stored in
* $HOME/Library/Log/UltraStar Deluxe/
*
* Music should go into ~/Music/UltraStar Deluxe/
*
* ~/Library/Application Support/UltraStarDeluxe_{USDX_VERSION}/songs is also used.
* ~/Library/Application Support/UltraStarDeluxe_[USDX_VERSION]/songs is also used.
* The idea is to remove this at some time.
*
*}
Expand All @@ -109,7 +109,7 @@ TPlatformMacOSX = class(TPlatform)

{**
* GetApplicationSupportPath returns the path to
* $HOME/Library/Application Support/UltraStarDeluxe_{USDX_VERSION}.
* $HOME/Library/Application Support/UltraStarDeluxe_[USDX_VERSION].
*}
function GetApplicationSupportPath: IPath;

Expand All @@ -127,7 +127,7 @@ TPlatformMacOSX = class(TPlatform)
{**
* Init simply calls @link(CreateUserFolders), which in turn scans the
* folder UltraStarDeluxe.app/Contents for all files and
* folders. $HOME/Library/Application Support/UltraStarDeluxe_{USDX_VERSION}
* folders. $HOME/Library/Application Support/UltraStarDeluxe_[USDX_VERSION]
* is then checked for their presence and missing ones are copied.
*}
procedure Init; override;
Expand All @@ -146,14 +146,14 @@ TPlatformMacOSX = class(TPlatform)

{**
* GetGameSharedPath returns the path for shared resources. Currently it
* is also set to $HOME/Library/Application Support/UltraStarDeluxe_{USDX_VERSION}.
* is also set to $HOME/Library/Application Support/UltraStarDeluxe_[USDX_VERSION].
* However it is not used.
*}
function GetGameSharedPath: IPath; override;

{**
* GetGameUserPath returns the path for user resources. Currently it is
* set to $HOME/Library/Application Support/UltraStarDeluxe_{USDX_VERSION}.
* set to $HOME/Library/Application Support/UltraStarDeluxe_[USDX_VERSION].
* This is where a user can add themes, ....
*}
function GetGameUserPath: IPath; override;
Expand Down Expand Up @@ -234,7 +234,7 @@ procedure TPlatformMacOSX.CreateUserFolders();
BaseDir := BaseDir.Append('Contents');
FileSystem.SetCurrentDir(BaseDir);

// Right now, only $HOME/Library/Application Support/UltraStarDeluxe_{USDX_VERSION} is used.
// Right now, only $HOME/Library/Application Support/UltraStarDeluxe_[USDX_VERSION] is used.
UserPath := GetGameUserPath();
if LogSwitch = On then
writeln('User path: ' + UserPath.ToNative);
Expand Down

0 comments on commit 80adde2

Please sign in to comment.