Address StyleCop warnings about fakeiteasy HOT 3 CLOSED

@FakeItEasy/owners so far I've managed to address all the warnings in the distributable (net40, net35, sl) projects apart from one rule:-

SA1623 : CSharp.Documentation : The property's documentation summary text must begin with: Gets

The problem is that this language doesn't really fit for fluent API properties. E.g.

    /// <summary>
    /// The call must have happened exactly the number of times
    //// that is specified in the next step.
    /// </summary>
    public static IRepeatSpecification Exactly
    {
        get { return new RepeatSpecification((actual, expected) =>
            actual == expected, "exactly"); }
    }

I don't think it would make sense to document this with something like "Gets a repeat specification that blah blah... ".

So, we have two options:-

1. Switch off the rule globally.
2. Add specific suppressions.

The advantage of the former is that it's quicker and it avoids littering the code with suppression attributes but the disadvantage is that there are many places in the code where this rule should be observed and those sites will no longer be checked.

The advantage of the latter is that the rule still stays in place for those code sites which require it but the disadvantage is that we have to add a suppression attribute to each fluent API property (there are currently 72 of them), e.g.

[SuppressMessage("StyleCop.CSharp.DocumentationRules",
    "SA1623:PropertySummaryDocumentationMustMatchAccessors", Justification = "Fluent API.")]

IMHO the latter is the more 'correct', if more verbose, solution and I don't mind taking the time to add the suppressions (it shouldn't take too long) so from that point of view I should probably just go ahead. However, It would also mean that we would have to add a suppression to any new fluent API properties when implementing new features so I guess we all need to be comfortable with that.

Thoughts?

from fakeiteasy.

@adamralph
According to http://stylecop.codeplex.com/wikipage?title=Rule%20Suppressions&referringTitle=Documentation (Suppress Message Usage) it should be possible to add the SuppressMessage attribute on the Repeated class. So we only need to add it for new classes, but not new members on existing classes.

I agree that we shouldn't suppress it globally

from fakeiteasy.

@philippdolder great! I guess in most cases the properties for a given type are either all fluent API properties or not at all so that should fit. If there is a case where it doesn't fit then I can still suppress at the member level.

In that case, I'll go ahead with suppressions. Thanks for the input.

from fakeiteasy.