feature: Add comments to generated InitializeComponent (#49)

src/Avalonia.NameGenerator.Tests/InitializeComponent/GeneratedInitializeComponent/AttachedProps.txt

@@ -10,6 +10,11 @@ namespace Sample.App
     {
         internal global::Avalonia.Controls.TextBox UserNameTextBox;
 
+        /// <summary>
+        /// Wires up the controls and optionally loads XAML markup and attaches dev tools (if Avalonia.Diagnostics package is referenced).
+        /// </summary>
+        /// <param name="loadXaml">Should the XAML be loaded into the component.</param>
+
         public void InitializeComponent(bool loadXaml = true)
         {
             if (loadXaml)

src/Avalonia.NameGenerator.Tests/InitializeComponent/GeneratedInitializeComponent/AttachedPropsWithDevTools.txt

@@ -10,6 +10,12 @@ namespace Sample.App
     {
         internal global::Avalonia.Controls.TextBox UserNameTextBox;
 
+        /// <summary>
+        /// Wires up the controls and optionally loads XAML markup and attaches dev tools (if Avalonia.Diagnostics package is referenced).
+        /// </summary>
+        /// <param name="loadXaml">Should the XAML be loaded into the component.</param>
+        /// <param name="attachDevTools">Should the dev tools be attached.</param>
+
         public void InitializeComponent(bool loadXaml = true, bool attachDevTools = true)
         {
             if (loadXaml)

src/Avalonia.NameGenerator.Tests/InitializeComponent/GeneratedInitializeComponent/ControlWithoutWindow.txt

@@ -10,6 +10,11 @@ namespace Sample.App
     {
         internal global::Avalonia.Controls.TextBox UserNameTextBox;
 
+        /// <summary>
+        /// Wires up the controls and optionally loads XAML markup and attaches dev tools (if Avalonia.Diagnostics package is referenced).
+        /// </summary>
+        /// <param name="loadXaml">Should the XAML be loaded into the component.</param>
+
         public void InitializeComponent(bool loadXaml = true)
         {
             if (loadXaml)

src/Avalonia.NameGenerator.Tests/InitializeComponent/GeneratedInitializeComponent/CustomControls.txt

@@ -12,6 +12,11 @@ namespace Sample.App
         internal global::Avalonia.ReactiveUI.RoutedViewHost UriRoutedViewHost;
         internal global::Controls.CustomTextBox UserNameTextBox;
 
+        /// <summary>
+        /// Wires up the controls and optionally loads XAML markup and attaches dev tools (if Avalonia.Diagnostics package is referenced).
+        /// </summary>
+        /// <param name="loadXaml">Should the XAML be loaded into the component.</param>
+
         public void InitializeComponent(bool loadXaml = true)
         {
             if (loadXaml)

src/Avalonia.NameGenerator.Tests/InitializeComponent/GeneratedInitializeComponent/DataTemplates.txt

@@ -11,6 +11,11 @@ namespace Sample.App
         internal global::Avalonia.Controls.TextBox UserNameTextBox;
         internal global::Avalonia.Controls.ListBox NamedListBox;
 
+        /// <summary>
+        /// Wires up the controls and optionally loads XAML markup and attaches dev tools (if Avalonia.Diagnostics package is referenced).
+        /// </summary>
+        /// <param name="loadXaml">Should the XAML be loaded into the component.</param>
+
         public void InitializeComponent(bool loadXaml = true)
         {
             if (loadXaml)

src/Avalonia.NameGenerator.Tests/InitializeComponent/GeneratedInitializeComponent/FieldModifier.txt

@@ -15,6 +15,11 @@ namespace Sample.App
         internal global::Avalonia.Controls.Button SignUpButton;
         internal global::Avalonia.Controls.Button RegisterButton;
 
+        /// <summary>
+        /// Wires up the controls and optionally loads XAML markup and attaches dev tools (if Avalonia.Diagnostics package is referenced).
+        /// </summary>
+        /// <param name="loadXaml">Should the XAML be loaded into the component.</param>
+
         public void InitializeComponent(bool loadXaml = true)
         {
             if (loadXaml)

src/Avalonia.NameGenerator.Tests/InitializeComponent/GeneratedInitializeComponent/NamedControl.txt

@@ -10,6 +10,11 @@ namespace Sample.App
     {
         internal global::Avalonia.Controls.TextBox UserNameTextBox;
 
+        /// <summary>
+        /// Wires up the controls and optionally loads XAML markup and attaches dev tools (if Avalonia.Diagnostics package is referenced).
+        /// </summary>
+        /// <param name="loadXaml">Should the XAML be loaded into the component.</param>
+
         public void InitializeComponent(bool loadXaml = true)
         {
             if (loadXaml)

src/Avalonia.NameGenerator.Tests/InitializeComponent/GeneratedInitializeComponent/NamedControls.txt

@@ -12,6 +12,11 @@ namespace Sample.App
         internal global::Avalonia.Controls.TextBox PasswordTextBox;
         internal global::Avalonia.Controls.Button SignUpButton;
 
+        /// <summary>
+        /// Wires up the controls and optionally loads XAML markup and attaches dev tools (if Avalonia.Diagnostics package is referenced).
+        /// </summary>
+        /// <param name="loadXaml">Should the XAML be loaded into the component.</param>
+
         public void InitializeComponent(bool loadXaml = true)
         {
             if (loadXaml)

src/Avalonia.NameGenerator.Tests/InitializeComponent/GeneratedInitializeComponent/NoNamedControls.txt

@@ -10,6 +10,11 @@ namespace Sample.App
     {
 
 
+        /// <summary>
+        /// Wires up the controls and optionally loads XAML markup and attaches dev tools (if Avalonia.Diagnostics package is referenced).
+        /// </summary>
+        /// <param name="loadXaml">Should the XAML be loaded into the component.</param>
+
         public void InitializeComponent(bool loadXaml = true)
         {
             if (loadXaml)

src/Avalonia.NameGenerator.Tests/InitializeComponent/GeneratedInitializeComponent/SignUpView.txt

@@ -18,6 +18,11 @@ namespace Sample.App
         internal global::Avalonia.Controls.Button SignUpButton;
         internal global::Avalonia.Controls.TextBlock CompoundValidation;
 
+        /// <summary>
+        /// Wires up the controls and optionally loads XAML markup and attaches dev tools (if Avalonia.Diagnostics package is referenced).
+        /// </summary>
+        /// <param name="loadXaml">Should the XAML be loaded into the component.</param>
+
         public void InitializeComponent(bool loadXaml = true)
         {
             if (loadXaml)

src/Avalonia.NameGenerator.Tests/InitializeComponent/GeneratedInitializeComponent/xNamedControl.txt

@@ -10,6 +10,11 @@ namespace Sample.App
     {
         internal global::Avalonia.Controls.TextBox UserNameTextBox;
 
+        /// <summary>
+        /// Wires up the controls and optionally loads XAML markup and attaches dev tools (if Avalonia.Diagnostics package is referenced).
+        /// </summary>
+        /// <param name="loadXaml">Should the XAML be loaded into the component.</param>
+
         public void InitializeComponent(bool loadXaml = true)
         {
             if (loadXaml)

src/Avalonia.NameGenerator.Tests/InitializeComponent/GeneratedInitializeComponent/xNamedControls.txt

@@ -12,6 +12,11 @@ namespace Sample.App
         internal global::Avalonia.Controls.TextBox PasswordTextBox;
         internal global::Avalonia.Controls.Button SignUpButton;
 
+        /// <summary>
+        /// Wires up the controls and optionally loads XAML markup and attaches dev tools (if Avalonia.Diagnostics package is referenced).
+        /// </summary>
+        /// <param name="loadXaml">Should the XAML be loaded into the component.</param>
+
         public void InitializeComponent(bool loadXaml = true)
         {
             if (loadXaml)

src/Avalonia.NameGenerator/Generator/InitializeComponentCodeGenerator.cs

@@ -14,6 +14,9 @@ namespace Avalonia.NameGenerator.Generator
                 this.AttachDevTools();
             }          
 #endif
+";
+        private const string AttachDevToolsParameterDocumentation
+            = @"        /// <param name=""attachDevTools"">Should the dev tools be attached.</param>
 ";
 
         public InitializeComponentCodeGenerator(IXamlTypeSystem types)
@@ -45,6 +48,11 @@ namespace {nameSpace}
     {{
 {string.Join("\n", properties)}
 
+        /// <summary>
+        /// Wires up the controls and optionally loads XAML markup and attaches dev tools (if Avalonia.Diagnostics package is referenced).
+        /// </summary>
+        /// <param name=""loadXaml"">Should the XAML be loaded into the component.</param>
+{(attachDevTools ? AttachDevToolsParameterDocumentation : string.Empty)}
         public void InitializeComponent(bool loadXaml = true{(attachDevTools ? ", bool attachDevTools = true" : string.Empty)})
         {{
             if (loadXaml)