Return Value Documentation Rules

/// <summary>A documented class.</summary>
public class MyClass
{
    /// <summary>Gets a value.</summary>
    public int GetValue() // CSENSE006
    {
        return 42;
    }

    /// <summary>Processes data asynchronously.</summary>
    public Task<int> ProcessAsync() // CSENSE006
    {
        return Task.FromResult(42);
    }

    /// <summary>Adds two numbers.</summary>
    /// <param name="a">The first number.</param>
    /// <param name="b">The second number.</param>
    public static int operator +(MyClass a, MyClass b) // CSENSE006
    {
        return 0;
    }
}

/// <summary>A documented class.</summary>
public class MyClass
{
    /// <summary>Gets a value.</summary>
    /// <returns>The integer value 42.</returns>
    public int GetValue()
    {
        return 42;
    }

    /// <summary>Processes data asynchronously.</summary>
    /// <returns>A task representing the asynchronous operation with the result.</returns>
    public Task<int> ProcessAsync()
    {
        return Task.FromResult(42);
    }

    /// <summary>Performs addition.</summary>
    /// <returns>The sum of the two values.</returns>
    public static int operator +(MyClass a, MyClass b)
    {
        return 0;
    }
}

/// <summary>A documented class.</summary>
public class MyClass
{
    /// <summary>Performs an action.</summary>
    public void DoSomething() // No CSENSE006 - void method
    {
    }

    /// <summary>Performs an async action.</summary>
    public async Task DoSomethingAsync() // No CSENSE006 - non-generic Task
    {
        await Task.Delay(100);
    }

    /// <summary>Performs an async action.</summary>
    public async ValueTask DoSomethingElseAsync() // No CSENSE006 - non-generic ValueTask
    {
        await Task.Delay(100);
    }
}

/// <summary>A documented class.</summary>
public class MyClass
{
    /// <summary>Performs an action.</summary>
    /// <returns>Nothing.</returns> // CSENSE013 - void method
    public void DoSomething()
    {
    }

    /// <summary>Gets or sets a value.</summary>
    /// <value>The property value.</value>
    /// <returns>The property value.</returns> // CSENSE013 - use <value> for properties
    public int MyProperty { get; set; }

    /// <summary>Initializes a new instance.</summary>
    /// <returns>A new instance.</returns> // CSENSE013 - constructors don't return values
    public MyClass()
    {
    }

    /// <summary>Gets a value.</summary>
    /// <returns>First description.</returns>
    /// <returns>Second description.</returns> // CSENSE013 - duplicate
    public int GetValue()
    {
        return 42;
    }
}

/// <summary>A documented class.</summary>
public class MyClass
{
    /// <summary>Performs an action.</summary>
    public void DoSomething()
    {
    }

    /// <summary>Gets or sets a value.</summary>
    /// <value>The property value.</value>
    public int MyProperty { get; set; }

    /// <summary>Initializes a new instance.</summary>
    public MyClass()
    {
    }

    /// <summary>Gets a value.</summary>
    /// <returns>The integer value 42.</returns>
    public int GetValue()
    {
        return 42;
    }
}

/// <summary>A documented class.</summary>
public class MyClass
{
    /// <summary>An async event handler.</summary>
    /// <returns>A task.</returns> // CSENSE013 - async void is still void
    public async void HandleEventAsync()
    {
        await Task.Delay(100);
    }
}

/// <summary>A documented class.</summary>
public class MyClass
{
    /// <summary>Performs an async operation.</summary>
    /// <returns>A task.</returns> // No CSENSE013 - Task is allowed to have <returns>
    public Task DoSomethingAsync()
    {
        return Task.CompletedTask;
    }
}