/Project/Src/AddIns/ReSharper/QuickFixes/Documentation/SA1629QuickFix.cs

// --------------------------------------------------------------------------------------------------------------------

// <copyright file="SA1629QuickFix.cs" company="http://stylecop.codeplex.com">

//   MS-PL

// </copyright>

// <license>

//   This source code is subject to terms and conditions of the Microsoft 

//   Public License. A copy of the license can be found in the License.html 

//   file at the root of this distribution. If you cannot locate the  

//   Microsoft Public License, please send an email to dlr@microsoft.com. 

//   By using this source code in any fashion, you are agreeing to be bound 

//   by the terms of the Microsoft Public License. You must not remove this 

//   notice, or any other, from this software.

// </license>

// <summary>

//   QuickFix - SA1629: DocumentationTextMustEndWithAPeriod.

// </summary>

// --------------------------------------------------------------------------------------------------------------------



namespace StyleCop.ReSharper.QuickFixes.Documentation

{

    #region Using Directives



    using System.Collections.Generic;



    using JetBrains.ReSharper.Feature.Services.Bulbs;



    using StyleCop.ReSharper.BulbItems.Documentation;

    using StyleCop.ReSharper.QuickFixes.Framework;

    using StyleCop.ReSharper.Violations;



    #endregion



    /// <summary>

    /// QuickFix - SA1629: DocumentationTextMustEndWithAPeriod.

    /// </summary>

    [ShowQuickFix]

    [QuickFix]

    public class SA1629QuickFix : QuickFixBase

    {

        #region Constructors and Destructors



        /// <summary>

        /// Initializes a new instance of the SA1629QuickFix class that can 

        /// handle <see cref="StyleCopViolationError"/>.

        /// </summary>

        /// <param name="highlight">

        /// <see cref="StyleCopViolationError"/>that has been detected.

        /// </param>

        public SA1629QuickFix(StyleCopViolationError highlight)

            : base(highlight)

        {

        }



        /// <summary>

        /// Initializes a new instance of the SA1629QuickFix class that can handle

        /// <see cref="StyleCopViolationHint"/>.

        /// </summary>

        /// <param name="highlight">

        /// <see cref="StyleCopViolationHint"/>that has been detected.

        /// </param>

        public SA1629QuickFix(StyleCopViolationHint highlight)

            : base(highlight)

        {

        }



        /// <summary>

        /// Initializes a new instance of the SA1629QuickFix class that can handle

        /// <see cref="StyleCopViolationInfo"/>.

        /// </summary>

        /// <param name="highlight">

        /// <see cref="StyleCopViolationInfo"/>that has been detected.

        /// </param>

        public SA1629QuickFix(StyleCopViolationInfo highlight)

            : base(highlight)

        {

        }



        /// <summary>

        /// Initializes a new instance of the SA1629QuickFix class that can handle

        /// <see cref="StyleCopViolationSuggestion"/>.

        /// </summary>

        /// <param name="highlight">

        /// <see cref="StyleCopViolationSuggestion"/>that has been detected.

        /// </param>

        public SA1629QuickFix(StyleCopViolationSuggestion highlight)

            : base(highlight)

        {

        }



        /// <summary>

        /// Initializes a new instance of the SA1629QuickFix class that can handle

        /// <see cref="StyleCopViolationWarning"/>.

        /// </summary>

        /// <param name="highlight">

        /// <see cref="StyleCopViolationWarning"/>that has been detected.

        /// </param>

        public SA1629QuickFix(StyleCopViolationWarning highlight)

            : base(highlight)

        {

        }



        #endregion



        #region Methods



        /// <summary>

        /// Initialises the QuickFix with all the available BulbItems that can fix the current

        /// StyleCop Violation.

        /// </summary>

        protected override void InitialiseBulbItems()

        {

            this.BulbItems = new List<IBulbItem> { new SA1629DocumentationTextMustEndWithAPeriodBulbItem { Description = "Documentation text must end with a '.' : " + this.Violation.ToolTip } };

        }



        #endregion

    }

}