Skip to content

Commit

Permalink
Add missing documentation (#742)
Browse files Browse the repository at this point in the history
Addressed a bunch of warnings and turned `GenerateDocumentationFile` back on.
  • Loading branch information
dalyIsaac authored Dec 25, 2023
1 parent 18bbcb1 commit 8ac6587
Show file tree
Hide file tree
Showing 12 changed files with 25 additions and 8 deletions.
5 changes: 4 additions & 1 deletion src/Directory.Build.props
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
<Project>
<PropertyGroup>
<GenerateDocumentationFile>false</GenerateDocumentationFile>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<!-- Workaround for IDE0005 (Remove unnecessary usings/imports); see
https://github.com/dotnet/roslyn/issues/41640 -->
<NoWarn>EnableGenerateDocumentationFile</NoWarn>
</PropertyGroup>
</Project>
5 changes: 5 additions & 0 deletions src/Whim.TestUtils/Directory.Build.props
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<Project>
<PropertyGroup>
<GenerateDocumentationFile>false</GenerateDocumentationFile>
</PropertyGroup>
</Project>
2 changes: 2 additions & 0 deletions src/Whim.TreeLayout.Bar/ToggleDirectionCommand.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ public class ToggleDirectionCommand : System.Windows.Input.ICommand
private readonly TreeLayoutEngineWidgetViewModel _viewModel;

/// <inheritdoc/>
#pragma warning disable CS0067 // The event 'ToggleDirectionCommand.CanExecuteChanged' is never used
public event EventHandler? CanExecuteChanged;
#pragma warning restore CS0067 // The event 'ToggleDirectionCommand.CanExecuteChanged' is never used

/// <summary>
/// Creates a new instance of <see cref="ToggleDirectionCommand"/>.
Expand Down
2 changes: 1 addition & 1 deletion src/Whim.TreeLayout.Tests/TreeLayoutCommandsTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace Whim.TreeLayout.Tests;

public class TreeLayoutCommandsTests
{
private class Wrapper
private sealed class Wrapper
{
public IContext Context { get; } = Substitute.For<IContext>();
public IMonitor Monitor { get; } = Substitute.For<IMonitor>();
Expand Down
2 changes: 1 addition & 1 deletion src/Whim.TreeLayout.Tests/Utils/LayoutEngineWrapper.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

namespace Whim.TreeLayout.Tests;

internal class LayoutEngineWrapper
internal sealed class LayoutEngineWrapper
{
public IContext Context { get; } = Substitute.For<IContext>();
public ITreeLayoutPlugin Plugin { get; } = Substitute.For<ITreeLayoutPlugin>();
Expand Down
2 changes: 1 addition & 1 deletion src/Whim.TreeLayout.Tests/Utils/SimpleTestTree.cs
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ namespace Whim.TreeLayout.Tests;
/// | | |
/// -----------------------------------------------
/// </summary>
internal class SimpleTestTree
internal sealed class SimpleTestTree
{
public SplitNode Root;
public SplitNode Top;
Expand Down
2 changes: 1 addition & 1 deletion src/Whim.TreeLayout.Tests/Utils/TestTree.cs
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ namespace Whim.TreeLayout.Tests;
/// | | |
/// ------------------------------------------------------------------------------------------------------------------------------------------------------------------
/// </summary>
internal class TestTree
internal sealed class TestTree
{
public SplitNode Root;
public WindowNode Left;
Expand Down
4 changes: 2 additions & 2 deletions src/Whim.TreeLayout/ITreeLayoutPlugin.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
namespace Whim.TreeLayout;

/// <summary>
/// TreeLayoutPlugin provides commands and functionality for the <see cref="TreeLayoutEngine"/>.
/// TreeLayoutPlugin does not load the <see cref="TreeLayoutEngine"/> - that is done when creating
/// <see cref="TreeLayoutPlugin"/> provides commands and functionality for the <see cref="TreeLayoutEngine"/>.
/// <see cref="TreeLayoutPlugin"/> does not load the <see cref="TreeLayoutEngine"/> - that is done when creating
/// a workspace via <see cref="IWorkspaceManager.Add"/>.
/// </summary>
public interface ITreeLayoutPlugin : IPlugin
Expand Down
1 change: 1 addition & 0 deletions src/Whim.TreeLayout/TreeLayoutEngine.cs
Original file line number Diff line number Diff line change
Expand Up @@ -685,5 +685,6 @@ WindowNode bNode
return new TreeLayoutEngine(this, currentNode, newWindows);
}

/// <inheritdoc />
public ILayoutEngine PerformCustomAction<T>(LayoutEngineCustomAction<T> action) => this;
}
5 changes: 5 additions & 0 deletions src/Whim.Updater.Tests/Directory.Build.props
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<Project>
<PropertyGroup>
<GenerateDocumentationFile>false</GenerateDocumentationFile>
</PropertyGroup>
</Project>
1 change: 1 addition & 0 deletions src/Whim/Layout/ColumnLayoutEngine.cs
Original file line number Diff line number Diff line change
Expand Up @@ -236,5 +236,6 @@ private static int GetDelta(bool leftToRight, Direction direction)
}
}

/// <inheritdoc/>
public ILayoutEngine PerformCustomAction<T>(LayoutEngineCustomAction<T> action) => this;
}
2 changes: 1 addition & 1 deletion src/Whim/Workspace/IWorkspace.cs
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ public interface IWorkspace : IDisposable
/// For more, see <see cref="ILayoutEngine.PerformCustomAction{T}" />.
/// </remarks>
/// <typeparam name="T">
/// The type of <paramref name="args" />'s payload.
/// The type of <paramref name="action" />'s payload.
/// </typeparam>
/// <param name="action">
/// Metadata about the action to perform, and the payload to perform it with.
Expand Down

0 comments on commit 8ac6587

Please sign in to comment.