Skip to content

Commit c3702a9

Browse files
committed
fix documentation make make project prod ready
1 parent 6887994 commit c3702a9

3 files changed

Lines changed: 24 additions & 3 deletions

File tree

src/PetroglyphTools/PG.StarWarsGame.Engine.FileSystem/IO/PetroglyphFileSystem.CombineJoin.cs

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,27 @@ namespace PG.StarWarsGame.Engine.IO;
66

77
public sealed partial class PetroglyphFileSystem
88
{
9+
/// <summary>
10+
/// Combines strings into a path.
11+
/// </summary>
12+
/// <remarks>
13+
/// <para>
14+
/// This method is intended to concatenate individual strings into a single string that represents a file path.
15+
/// However, if an argument other than the first contains a rooted path, any previous path components are ignored,
16+
/// and the returned string begins with that rooted path component.
17+
/// </para>
18+
/// <para>
19+
/// This method supports the directory separator characters ("/") and ("\").
20+
/// </para>
21+
/// </remarks>
22+
/// <param name="pathA">The first path to combine.</param>
23+
/// <param name="pathB">The second path to combine.</param>
24+
/// <returns>
25+
/// The combined paths. If one of the specified paths is a zero-length string, this method returns the other path.
26+
/// If <paramref name="pathB"/> contains an absolute path, this method returns <paramref name="pathB"/>.
27+
/// </returns>
28+
/// <exception cref="ArgumentNullException"><paramref name="pathA"/> or <paramref name="pathB"/> is <see langword="null"/>.
29+
/// </exception>
930
public string CombinePath(string pathA, string pathB)
1031
{
1132
if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))

src/PetroglyphTools/PG.StarWarsGame.Engine.FileSystem/IO/PetroglyphFileSystem.Strategies.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ public sealed partial class PetroglyphFileSystem
2323
/// <remarks>
2424
/// <note type="warning">
2525
/// Selecting this strategy directly is rarely correct. Prefer
26-
/// <see cref="UseVirtualStrategy"/> on non-Windows hosts and <see cref="UseWindowsStrategy"/>
26+
/// <see cref="UseVirtualStrategy(bool?)"/> on non-Windows hosts and <see cref="UseWindowsStrategy"/>
2727
/// on Windows. This method exists primarily to support the search engine used internally by
28-
/// <see cref="UseVirtualStrategy"/> for paths outside the game directory.
28+
/// <see cref="UseVirtualStrategy(bool?)"/> for paths outside the game directory.
2929
/// </note>
3030
/// <para>Provides full mediation: every lookup re-walks the path with no caching.</para>
3131
/// </remarks>

src/PetroglyphTools/PG.StarWarsGame.Engine.FileSystem/PG.StarWarsGame.Engine.FileSystem.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<PackageTags>alamo,petroglyph,glyphx</PackageTags>
99
</PropertyGroup>
1010
<PropertyGroup>
11-
<!--<TreatWarningsAsErrors>true</TreatWarningsAsErrors>-->
11+
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
1212
<GenerateDocumentationFile>true</GenerateDocumentationFile>
1313
<InheritDocEnabled>true</InheritDocEnabled>
1414
</PropertyGroup>

0 commit comments

Comments
 (0)