diff --git a/Dalamud/Interface/Components/ComponentDemoWindow.cs b/Dalamud/Interface/Components/ComponentDemoWindow.cs
index 244a43222..bc25cc1d4 100644
--- a/Dalamud/Interface/Components/ComponentDemoWindow.cs
+++ b/Dalamud/Interface/Components/ComponentDemoWindow.cs
@@ -5,7 +5,9 @@ using ImGuiNET;
namespace Dalamud.Interface.Components
{
-
+ ///
+ /// Component Demo Window to view custom components.
+ ///
internal class ComponentDemoWindow : Window
{
private readonly IComponent[] components =
@@ -13,6 +15,9 @@ namespace Dalamud.Interface.Components
new TestComponent(),
};
+ ///
+ /// Initializes a new instance of the class.
+ ///
public ComponentDemoWindow()
: base("Dalamud Components Demo")
{
@@ -20,6 +25,7 @@ namespace Dalamud.Interface.Components
this.SizeCondition = ImGuiCond.FirstUseEver;
}
+ ///
public override void Draw()
{
ImGui.BeginChild("comp_scrolling", new Vector2(0, 0), false, ImGuiWindowFlags.AlwaysVerticalScrollbar | ImGuiWindowFlags.HorizontalScrollbar);
diff --git a/Dalamud/Interface/Components/IComponent.cs b/Dalamud/Interface/Components/IComponent.cs
index 02784000c..9a7ac55b6 100644
--- a/Dalamud/Interface/Components/IComponent.cs
+++ b/Dalamud/Interface/Components/IComponent.cs
@@ -6,7 +6,7 @@ namespace Dalamud.Interface.Components
public interface IComponent
{
///
- /// Gets or sets the name of the component.
+ /// Gets the name of the component.
///
public string Name { get; }
diff --git a/Dalamud/Interface/Components/TestComponent.cs b/Dalamud/Interface/Components/TestComponent.cs
index 587f3757a..30412be8b 100644
--- a/Dalamud/Interface/Components/TestComponent.cs
+++ b/Dalamud/Interface/Components/TestComponent.cs
@@ -1,16 +1,20 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
using ImGuiNET;
namespace Dalamud.Interface.Components
{
- class TestComponent : IComponent
+ ///
+ /// Test component to demonstrate how ImGui components work.
+ ///
+ public class TestComponent : IComponent
{
+ ///
+ /// Gets component name.
+ ///
public string Name { get; } = "Test Component";
+ ///
+ /// Draw test component.
+ ///
public void Draw()
{
ImGui.Text("You are viewing the test component. The test was a success.");