Skip to content

Fix DocFX warnings in XML documentation #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
konard wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix DocFX warnings in XML documentation #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
08ff269
Initial commit with task details for issue #3
konard Sep 14, 2025
dfde1bf
Fix DocFX warnings by cleaning up XML documentation
konard Sep 14, 2025
6c4ad26
Remove CLAUDE.md - Claude command completed
konard Sep 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions csharp/Platform.RegularExpressions.Transformer.Tests/FileTransformerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,13 @@ namespace Platform.RegularExpressions.Transformer.Tests
/// <para>
/// Represents the file transformer tests.
/// </para>
/// <para></para>
/// </summary>
public class FileTransformerTests
{
/// <summary>
/// <para>
/// Tests that folder to folder transfomation test.
/// </para>
/// <para></para>
/// </summary>
[Fact]
public void FolderToFolderTransfomationTest()
Expand Down
3 changes: 1 addition & 2 deletions csharp/Platform.RegularExpressions.Transformer.Tests/MarkovAlgorithmsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ namespace Platform.RegularExpressions.Transformer.Tests
/// <para>
/// Represents the markov algorithms tests.
/// </para>
/// <para></para>
/// </summary>
public class MarkovAlgorithmsTests
{
Expand All @@ -21,7 +20,7 @@ public void BinaryToUnaryNumbersTest()
{
("1", "0|", int.MaxValue), // "1" -> "0|" repeated forever
// | symbol should be escaped for regular expression pattern, but not in the substitution pattern
(@"\|0", "0||", int.MaxValue), // "\|0" -> "0||" repeated forever
(@"\|0", "0||", int.MaxValue), // "\|0" -> "0||" repeated forever
("0", "", int.MaxValue), // "0" -> "" repeated forever
};
var transformer = new TextTransformer(rules);
Expand Down
2 changes: 0 additions & 2 deletions csharp/Platform.RegularExpressions.Transformer.Tests/SubstitutionRuleTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,13 @@ namespace Platform.RegularExpressions.Transformer.Tests
/// <para>
/// Represents the substitution rule tests.
/// </para>
/// <para></para>
/// </summary>
public class SubstitutionRuleTests
{
/// <summary>
/// <para>
/// Tests that options override test.
/// </para>
/// <para></para>
/// </summary>
[Fact]
public void OptionsOverrideTest()
Expand Down
17 changes: 0 additions & 17 deletions csharp/Platform.RegularExpressions.Transformer.Tests/TextTransformerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,13 @@ namespace Platform.RegularExpressions.Transformer.Tests
/// <para>
/// Represents the text transformer tests.
/// </para>
/// <para></para>
/// </summary>
public class TextTransformerTests
{
/// <summary>
/// <para>
/// Tests that debug output test.
/// </para>
/// <para></para>
/// </summary>
[Fact]
public void DebugOutputTest()
Expand All @@ -42,7 +40,6 @@ public void DebugOutputTest()
/// <para>
/// Tests that debug files output test.
/// </para>
/// <para></para>
/// </summary>
[Fact]
public void DebugFilesOutputTest()
Expand All @@ -67,23 +64,18 @@ public void DebugFilesOutputTest()
/// <para>
/// Checks the and clean up two rules files using the specified first step reference text.
/// </para>
/// <para></para>
/// </summary>
/// <param name="firstStepReferenceText">
/// <para>The first step reference text.</para>
/// <para></para>
/// </param>
/// <param name="secondStepReferenceText">
/// <para>The second step reference text.</para>
/// <para></para>
/// </param>
/// <param name="transformer">
/// <para>The transformer.</para>
/// <para></para>
/// </param>
/// <param name="targetFilename">
/// <para>The target filename.</para>
/// <para></para>
/// </param>
private static void CheckAndCleanUpTwoRulesFiles(string firstStepReferenceText, string secondStepReferenceText, TextTransformer transformer, string targetFilename)
{
Expand Down Expand Up @@ -112,7 +104,6 @@ private static void CheckAndCleanUpTwoRulesFiles(string firstStepReferenceText,
/// <para>
/// Tests that files with no changes skiped test.
/// </para>
/// <para></para>
/// </summary>
[Fact]
public void FilesWithNoChangesSkipedTest()
Expand All @@ -138,23 +129,18 @@ public void FilesWithNoChangesSkipedTest()
/// <para>
/// Checks the and clean up three rules files using the specified first step reference text.
/// </para>
/// <para></para>
/// </summary>
/// <param name="firstStepReferenceText">
/// <para>The first step reference text.</para>
/// <para></para>
/// </param>
/// <param name="thirdStepReferenceText">
/// <para>The third step reference text.</para>
/// <para></para>
/// </param>
/// <param name="transformer">
/// <para>The transformer.</para>
/// <para></para>
/// </param>
/// <param name="targetFilename">
/// <para>The target filename.</para>
/// <para></para>
/// </param>
private static void CheckAndCleanUpThreeRulesFiles(string firstStepReferenceText, string thirdStepReferenceText, TextTransformer transformer, string targetFilename)
{
Expand Down Expand Up @@ -189,7 +175,6 @@ private static void CheckAndCleanUpThreeRulesFiles(string firstStepReferenceText
/// <para>
/// Tests that debug output using transformers generation test.
/// </para>
/// <para></para>
/// </summary>
[Fact]
public void DebugOutputUsingTransformersGenerationTest()
Expand All @@ -214,7 +199,6 @@ public void DebugOutputUsingTransformersGenerationTest()
/// <para>
/// Tests that debug files output using transformers generation test.
/// </para>
/// <para></para>
/// </summary>
[Fact]
public void DebugFilesOutputUsingTransformersGenerationTest()
Expand All @@ -239,7 +223,6 @@ public void DebugFilesOutputUsingTransformersGenerationTest()
/// <para>
/// Tests that files with no changes skiped when using transformers generation test.
/// </para>
/// <para></para>
/// </summary>
[Fact]
public void FilesWithNoChangesSkipedWhenUsingTransformersGenerationTest()
Expand Down
Loading
Loading