Skip to content

Commit

Permalink
Added missing xml comments
Browse files Browse the repository at this point in the history
  • Loading branch information
ben_singer committed Nov 29, 2024
1 parent 98193a9 commit 94ad376
Show file tree
Hide file tree
Showing 22 changed files with 22 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ public sealed class ConsoleAboutFrameBuilder(GridStringBuilder gridStringBuilder
/// <param name="title">The title.</param>
/// <param name="game">The game.</param>
/// <param name="size">The size of the frame.</param>
/// <returns>The frame.</returns>
public IFrame Build(string title, Game game, Size size)
{
gridStringBuilder.Resize(size);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ public sealed class ConsoleCommandListFrameBuilder(GridStringBuilder gridStringB
/// <param name="description">The description.</param>
/// <param name="commandHelp">The command help.</param>
/// <param name="size">The size of the frame.</param>
/// <returns>The frame.</returns>
public IFrame Build(string title, string description, CommandHelp[] commandHelp, Size size)
{
gridStringBuilder.Resize(size);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ public sealed class ConsoleCompletionFrameBuilder(GridStringBuilder gridStringBu
/// <param name="message">The message to display to the user.</param>
/// <param name="reason">The reason the game ended.</param>
/// <param name="size">The size of the frame.</param>
/// <returns>The frame.</returns>
public IFrame Build(string message, string reason, Size size)
{
gridStringBuilder.Resize(size);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ internal static LogItem[] TruncateLog(int startX, int availableWidth, int availa
/// <param name="converser">The converser.</param>
/// <param name="contextualCommands">The contextual commands to display.</param>
/// <param name="size">The size of the frame.</param>
/// <returns>The frame.</returns>
public IFrame Build(string title, IConverser converser, CommandHelp[] contextualCommands, Size size)
{
gridStringBuilder.Resize(size);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ public sealed class ConsoleGameOverFrameBuilder(GridStringBuilder gridStringBuil
/// <param name="message">The message to display to the user.</param>
/// <param name="reason">The reason the game ended.</param>
/// <param name="size">The size of the frame.</param>
/// <returns>The frame.</returns>
public IFrame Build(string message, string reason, Size size)
{
gridStringBuilder.Resize(size);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ public sealed class ConsoleHelpFrameBuilder(GridStringBuilder gridStringBuilder)
/// <param name="title">The title.</param>
/// <param name="commandHelp">The command help.</param>
/// <param name="size">The size of the frame.</param>
/// <returns>The frame.</returns>
public IFrame Build(string title, CommandHelp commandHelp, Size size)
{
gridStringBuilder.Resize(size);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ public sealed class ConsoleReactionFrameBuilder(GridStringBuilder gridStringBuil
/// <param name="message">The message to display to the user.</param>
/// <param name="isError">If the message is an error.</param>
/// <param name="size">The size of the frame.</param>
/// <returns>The frame.</returns>
public IFrame Build(string title, string message, bool isError, Size size)
{
gridStringBuilder.Resize(size);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ public sealed class ConsoleRegionMapFrameBuilder(GridStringBuilder gridStringBui
/// <param name="focusPosition">The position to focus on.</param>
/// <param name="contextualCommands">The contextual commands to display.</param>
/// <param name="size">The size of the frame.</param>
/// <returns>The frame.</returns>
public IFrame Build(Region region, Point3D focusPosition, CommandHelp[] contextualCommands, Size size)
{
gridStringBuilder.Resize(size);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ public sealed class ConsoleSceneFrameBuilder(GridStringBuilder gridStringBuilder
/// <param name="contextualCommands">The contextual commands to display.</param>
/// <param name="keyType">The type of key to use.</param>
/// <param name="size">The size of the frame.</param>
/// <returns>The frame.</returns>
public IFrame Build(Room room, ViewPoint viewPoint, PlayableCharacter player, CommandHelp[] contextualCommands, KeyType keyType, Size size)
{
var availableWidth = size.Width - 4;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ public sealed class ConsoleTitleFrameBuilder(GridStringBuilder gridStringBuilder
/// <param name="title">The title.</param>
/// <param name="description">The description.</param>
/// <param name="size">The size of the frame.</param>
/// <returns>The frame.</returns>
public IFrame Build(string title, string description, Size size)
{
gridStringBuilder.Resize(size);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ public sealed class ConsoleVisualFrameBuilder(GridStringBuilder gridStringBuilde
/// <param name="description">The description.</param>
/// <param name="gridVisualBuilder">The grid visual builder.</param>
/// <param name="size">The size of the frame.</param>
/// <returns>The frame.</returns>
public IFrame Build(string title, string description, GridVisualBuilder gridVisualBuilder, Size size)
{
gridStringBuilder.Resize(size);
Expand Down
1 change: 1 addition & 0 deletions NetAF/Rendering/FrameBuilders/IAboutFrameBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ public interface IAboutFrameBuilder
/// <param name="title">The title.</param>
/// <param name="game">The game.</param>
/// <param name="size">The size of the frame.</param>
/// <returns>The frame.</returns>
IFrame Build(string title, Game game, Size size);
}
}
1 change: 1 addition & 0 deletions NetAF/Rendering/FrameBuilders/ICommandListFrameBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ public interface ICommandListFrameBuilder
/// <param name="description">The description.</param>
/// <param name="commandHelp">The command help.</param>
/// <param name="size">The size of the frame.</param>
/// <returns>The frame.</returns>
IFrame Build(string title, string description, CommandHelp[] commandHelp, Size size);
}
}
1 change: 1 addition & 0 deletions NetAF/Rendering/FrameBuilders/ICompletionFrameBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ public interface ICompletionFrameBuilder
/// <param name="message">The message to display to the user.</param>
/// <param name="reason">The reason the game ended.</param>
/// <param name="size">The size of the frame.</param>
/// <returns>The frame.</returns>
IFrame Build(string message, string reason, Size size);
}
}
1 change: 1 addition & 0 deletions NetAF/Rendering/FrameBuilders/IConversationFrameBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ public interface IConversationFrameBuilder
/// <param name="converser">The converser.</param>
/// <param name="contextualCommands">The contextual commands to display.</param>
/// <param name="size">The size of the frame.</param>
/// <returns>The frame.</returns>
IFrame Build(string title, IConverser converser, CommandHelp[] contextualCommands, Size size);
}
}
1 change: 1 addition & 0 deletions NetAF/Rendering/FrameBuilders/IGameOverFrameBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ public interface IGameOverFrameBuilder
/// <param name="message">The message to display to the user.</param>
/// <param name="reason">The reason the game ended.</param>
/// <param name="size">The size of the frame.</param>
/// <returns>The frame.</returns>
IFrame Build(string message, string reason, Size size);
}
}
1 change: 1 addition & 0 deletions NetAF/Rendering/FrameBuilders/IHelpFrameBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ public interface IHelpFrameBuilder
/// <param name="title">The title.</param>
/// <param name="commandHelp">The command help.</param>
/// <param name="size">The size of the frame.</param>
/// <returns>The frame.</returns>
IFrame Build(string title, CommandHelp commandHelp, Size size);
}
}
1 change: 1 addition & 0 deletions NetAF/Rendering/FrameBuilders/IReactionFrameBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ public interface IReactionFrameBuilder
/// <param name="message">The message to display to the user.</param>
/// <param name="isError">If the message is an error.</param>
/// <param name="size">The size of the frame.</param>
/// <returns>The frame.</returns>
IFrame Build(string title, string message, bool isError, Size size);
}
}
1 change: 1 addition & 0 deletions NetAF/Rendering/FrameBuilders/IRegionMapFrameBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ public interface IRegionMapFrameBuilder
/// <param name="focusPosition">The position to focus on.</param>
/// <param name="contextualCommands">The contextual commands to display.</param>
/// <param name="size">The size of the frame.</param>
/// <returns>The frame.</returns>
IFrame Build(Region region, Point3D focusPosition, CommandHelp[] contextualCommands, Size size);
}
}
1 change: 1 addition & 0 deletions NetAF/Rendering/FrameBuilders/ISceneFrameBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ public interface ISceneFrameBuilder
/// <param name="contextualCommands">The contextual commands to display.</param>
/// <param name="keyType">The type of key to use.</param>
/// <param name="size">The size of the frame.</param>
/// <returns>The frame.</returns>
IFrame Build(Room room, ViewPoint viewPoint, PlayableCharacter player, CommandHelp[] contextualCommands, KeyType keyType, Size size);
}
}
1 change: 1 addition & 0 deletions NetAF/Rendering/FrameBuilders/ITitleFrameBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ public interface ITitleFrameBuilder
/// <param name="title">The title.</param>
/// <param name="description">The description.</param>
/// <param name="size">The size of the frame.</param>
/// <returns>The frame.</returns>
IFrame Build(string title, string description, Size size);
}
}
1 change: 1 addition & 0 deletions NetAF/Rendering/FrameBuilders/IVisualFrameBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ public interface IVisualFrameBuilder
/// <param name="description">The description.</param>
/// <param name="gridVisualBuilder">The grid visual builder.</param>
/// <param name="size">The size of the frame.</param>
/// <returns>The frame.</returns>
IFrame Build(string title, string description, GridVisualBuilder gridVisualBuilder, Size size);
}
}

0 comments on commit 94ad376

Please sign in to comment.