Skip to content

Commit

Permalink
Add a doc comment to StringReplace (#748)
Browse files Browse the repository at this point in the history
This is an initial test to get formatting etc agreed upon to then
build on this further
  • Loading branch information
GeckoEidechse authored Dec 4, 2023
1 parent bdb73b1 commit 0c5c9b1
Showing 1 changed file with 8 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -348,6 +348,14 @@ string function GetMapDisplayDesc( string mapname )
return "#" + mapname + "_CLASSIC_DESC"
}

/// Sends a string message to player
/// * `baseString` - The input string to search through
/// * `searchString` - Find this substring...
/// * `replaceString` - ...and replace with this substring
/// * `replaceAll` - Whether to replace all occurences or just the first
/// * `caseInsensitive` - Whether to consider casing (upper/lower)
///
/// Returns the updated string
string function StringReplace( string baseString, string searchString, string replaceString, bool replaceAll = false, bool caseInsensitive = false )
{
bool loopedOnce = false
Expand Down

0 comments on commit 0c5c9b1

Please sign in to comment.