Inheritdoc support

Author: winscripter

README.md

@@ -5,14 +5,15 @@
 A Visual Studio extension that lets you generate common methods in C# - parameterless constructors, `GetHashCode`, `Equals`, and equality operators - with XML documentation automatically inserted for you.
 
 # ❓ How does it work?
-When you install the extension, you get four new code actions for classes and structs!
+When you install the extension, you get 7 new code actions for classes and structs!
 
 - `XML: Add Equality Methods to Fields`: When you click this, it generates `GetHashCode`, `Equals`, `IEquatable`, and equality operators for all fields, + XML documentation.
 - `XML: Add Equality Methods to Properties`: Same as the one above, but for properties.
 - `XML: Add Equality Methods to Members`: Same as the one above, but for both Fields and Properties.
 - `XML: Add Parameterless Constructor`: Adds an empty constructor without any parameters, with XML documentation
+- There's also the three other options: Equality methods, but with `(Use inheritdoc)`. These apply an `<inheritdoc cref="..." />` to methods like GetHashCode, IEquatable.Equals, and object.Equals.
 
-![Screenshot](media/Screenshot%202025-08-28%20074816.png)
+![Screenshot](media/Screenshot%202025-08-28%20133212.png)
 
 You no longer have to manually write XML documentation for methods like `GetHashCode` or `Equals` - even an `<inheritdoc ... />` can take some time to write! AddWithXmlDoc does that for you.
 
@@ -31,73 +32,7 @@ public class Class1
 }
 ```
 
-Right click on `Class1`. Click `XML: Add Equality Methods to Members`.
-Our class now looks like this. With just one click.
-
-```cs
-public class Class1 : IEquatable<Class1>
-{
-    public string Greeting { get; set; }
-        = "Welcome to AddWithXmlDoc!"
-
-    /// <summary>
-    /// Determines if this instance is equal to the other instance of type <see cref = "Class1"/>.
-    /// </summary>
-    /// <param name = "other">The other value to compare this instance with.</param>
-    /// <returns>A boolean that, if <see langword="true"/>, indicates that <paramref name = "other"/> is equal to this instance, is of same type as this instance, and is not null.</returns>
-    public override bool Equals(object? other)
-    {
-        return other is Class1 value && Equals(value);
-    }
-
-    /// <summary>
-    /// Determines if this instance is equal to the other instance of type <see cref = "Class1"/>.
-    /// </summary>
-    /// <param name = "other">The other instance to compare this instance with.</param>
-    /// <returns>A boolean that, if <see langword="true"/>, indicates that <paramref name = "other"/> is equal to this instance.</returns>
-    public bool Equals(Class1? other)
-    {
-        return this.Greeting == other?.Greeting;
-    }
-
-    /// <summary>
-    /// Computes the hash code for this object.
-    /// </summary>
-    /// <returns>This object's hash code.</returns>
-    public override int GetHashCode()
-    {
-        var hashCode = new HashCode();
-        hashCode.Add(this.Greeting);
-        return hashCode.ToHashCode();
-    }
-
-    /// <summary>
-    /// Determines if <paramref name = "left"/> is equal to <paramref name = "right"/>.
-    /// </summary>
-    /// <param name = "left">The value to compare from.</param>
-    /// <param name = "right">The value to compare with.</param>
-    /// <returns><see langword="true"/> if the left parameter is same as the right parameter, otherwise <see langword="false"/>.</returns>
-    public static bool operator ==(Class1 left, Class1 right)
-    {
-        return left.Equals(right);
-    }
-
-    /// <summary>
-    /// Determines if <paramref name = "left"/> is not equal to <paramref name = "right"/>.
-    /// </summary>
-    /// <param name = "left">The value to compare from.</param>
-    /// <param name = "right">The value to compare with.</param>
-    /// <returns><see langword="true"/> if the left parameter is different compared to the right parameter, otherwise <see langword="false"/> if both are same.</returns>
-    public static bool operator !=(Class1 left, Class1 right)
-    {
-        return !(left == right);
-    }
-}
-```
-
-Typing all of this would've took a while!
-
-Or, instead, click `XML: Add Parameterless Constructor`. Our class now looks like this.
+Right click on `Class1`. Click `XML: Add Parameterless Constructor`. Our class now looks like this.
 
 ```cs
 public class Class1
@@ -114,6 +49,11 @@ public class Class1
 }
 ```
 
+It also supports generating `GetHashCode()`, `IEquatable.Equals`, `object.Equals`, `==`, and `!=`. Examples of generated code for such methods are documented in the docs. (See below)
+
+# 📄 Docs
+See [docs.md](docs/docs.md)
+
 # 🧱 Prerequisites
 AddWithXmlDoc supports all Visual Studio versions starting from Visual Studio 2022. You should have
 Visual Studio versions at least 2022 to use AddWithXmlDoc.

docs/docs.md

@@ -0,0 +1,48 @@
+**Table of Contents**
+1. [Installation](#installation)
+    - 1.1. [Via Visual Studio Marketplace](#install-vsm)
+    - 1.2. [Via GitHub](#install-gh)
+2. [Usage](#usage)
+    - 2.1. [Initial Code](#code-init)
+    - 2.2. [Code after clicking to generate equality methods for fields with XML documentation](#code-eq-fields-xml)
+    - 2.3. [Code after clicking to generate equality methods for fields with XML documentation, using inheritdoc where possible](#code-eq-fields-xml-inheritdoc)
+
+<a name="installation"></a>
+
+# 1. Installation
+This clause describes how to install AddWithXmlDoc.
+
+<a name="install-vsm"></a>
+
+### 1.1. Via Visual Studio Marketplace
+Go to https://marketplace.visualstudio.com/items?itemName=winscripter.ExtVSAddWithXmlDoc. Click the Green download button. Double click the downloaded `.vsix` file and follow the instructions.
+
+<a name="install-gh"></a>
+
+### 1.2. Via GitHub
+Go to the [Releases Page](https://github.com/winscripter/AddWithXmlDoc/releases). Click on the latest release, click on the `.vsix` file. Double click the downloaded `.vsix` file and follow the instructions.
+
+<a name="usage"></a>
+
+# 2. Usage
+
+<a name="code-init"></a>
+
+### 2.1. Initial code
+Right click on the class name, and click `Quick Actions and Refactorings`, with the light bulb to the left of it.
+
+![Initial Code](../media/docs/InitialCode.png)
+
+<a name="code-eq-fields-xml"></a>
+
+### 2.2. Code after clicking to generate equality methods for fields with XML documentation
+We had to decrease the scaling so the image isn't too big. As you can see, lots of code was generated. That much time was saved!
+
+![Code](../media/docs/GenerateField.png)
+
+<a name="code-eq-fields-xml-inheritdoc"></a>
+
+### 2.3. Code after clicking to generate equality methods for fields with XML documentation, using inheritdoc where possible
+We had to decrease the scaling so the image isn't too big. As you can see, lots of code was generated. That much time was saved!
+
+![Code](../media/docs/InheritdocGenerateField.png)

media/Screenshot 2025-08-28 074816.png

@@ -12,20 +12,6 @@
 
 var type = parsed.GetRoot().DescendantNodes().OfType<TypeDeclarationSyntax>().First();
 
-csharpLSC.AddEqualityMembersToFields.ProvideRootNode(type);
-csharpLSC.AddEqualityMembersToFields.Invoke((newNode) =>
-{
-    Console.WriteLine("Equality to Fields:");
-    Console.WriteLine(newNode.ToString());
-});
-
-csharpLSC.AddEqualityMembersToProperties.ProvideRootNode(type);
-csharpLSC.AddEqualityMembersToProperties.Invoke((newNode) =>
-{
-    Console.WriteLine("Equality to Properties:");
-    Console.WriteLine(newNode.ToString());
-});
-
 csharpLSC.AddEqualityMembersToMembers.ProvideRootNode(type);
 csharpLSC.AddEqualityMembersToMembers.Invoke((newNode) =>
 {
@@ -39,3 +25,11 @@
     Console.WriteLine("Parameterless Constructor:");
     Console.WriteLine(newNode.ToString());
 });
+
+csharpLSC.AddEqualityMembersToMembers.UseInheritdocWherePossible = true;
+csharpLSC.AddEqualityMembersToMembers.ProvideRootNode(type);
+csharpLSC.AddEqualityMembersToMembers.Invoke((newNode) =>
+{
+    Console.WriteLine("Inheritdoc Equality to Members:");
+    Console.WriteLine(newNode.ToString());
+});

media/Screenshot 2025-08-28 133212.png

@@ -39,4 +39,9 @@ public interface IXmlAdd
     /// </summary>
     /// <param name="del">Once the operation is complete, the new node is sent here.</param>
     void Invoke(NewNodeDelegate del);
+
+    /// <summary>
+    ///   Makes use of the &lt;inheritdoc cref="..." /&gt; element where possible. Default value: <see langword="false"/>.
+    /// </summary>
+    bool UseInheritdocWherePossible { get; set; }
 }

media/docs/GenerateField.png

@@ -15,11 +15,12 @@
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <RepositoryUrl>https://github.com/winscripter/AddWithXmlDoc</RepositoryUrl>
     <PackageTags>VisualStudio;Visual Studio;Roslyn;C#;CSharp;Code;Generator;SourceGeneration;Source Generation</PackageTags>
-    <AssemblyVersion>1.0.2.0</AssemblyVersion>
-    <FileVersion>1.0.2.0</FileVersion>
+    <AssemblyVersion>2.0.0.0</AssemblyVersion>
+    <FileVersion>2.0.0.0</FileVersion>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
-    <Version>1.0.2</Version>
+    <Version>2.0.0</Version>
+    <PackageReleaseNotes>Added inheritdoc support</PackageReleaseNotes>
   </PropertyGroup>
 
   <ItemGroup>