Skip to content

Commit

Permalink
better documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Metraberryy committed Jan 10, 2025
1 parent 045a39b commit 829b067
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
3 changes: 2 additions & 1 deletion ProjectLighthouse/Types/Entities/Level/SlotEntity.cs
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ public class SlotEntity
public string IconHash { get; set; } = "";

Check warning on line 30 in ProjectLighthouse/Types/Entities/Level/SlotEntity.cs

View workflow job for this annotation

GitHub Actions / Qodana for .NET

Possible performance issues caused by unlimited string length

Possible performance issues caused by unlimited string length

/// <summary>
/// Markup that displays the level name next to its badge
/// Markup that displays the level name next to its badge.
/// This can be used everywhere markup works ingame, e.g. news or notifications
/// </summary>
[NotMapped]
public string InfoXml => $"<slot type=\"{this.Type}\" id=\"{this.SlotId}\" icon=\"{this.IconHash}\">{this.Name}</slot>";
Expand Down
3 changes: 2 additions & 1 deletion ProjectLighthouse/Types/Entities/Profile/UserEntity.cs
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ public class UserEntity
public string IconHash { get; set; }

Check warning on line 29 in ProjectLighthouse/Types/Entities/Profile/UserEntity.cs

View workflow job for this annotation

GitHub Actions / Qodana for .NET

Possible performance issues caused by unlimited string length

Possible performance issues caused by unlimited string length

/// <summary>
/// Markup that displays the username next to a polaroid with the user's icon ingame
/// Markup that displays the username next to a polaroid with the user's icon.
/// This can be used everywhere markup works ingame, e.g. news or notifications
/// </summary>
[NotMapped]
public string InfoXml => $"<player icon=\"{this.IconHash}\">{this.Username}</player>";
Expand Down

0 comments on commit 829b067

Please sign in to comment.