/// <summary>
/// Ensures that the constructor documentation starts with the standard text summary.
/// </summary>
/// <remarks>
/// Keeps the existing comment, but prepends the standard text.
/// </remarks>
/// <param name="constructorDeclaration">
/// The destructor <see cref="IDeclaration"/>.
/// </param>
public void EnsureConstructorSummaryDocBeginsWithStandardText(IConstructorDeclaration constructorDeclaration)
{
if (constructorDeclaration == null)
{
return;
}
IContextBoundSettingsStore settingsStore = PsiSourceFileExtensions.GetSettingsStore(null, constructorDeclaration.GetSolution());
if (!settingsStore.GetValue((StyleCopOptionsSettingsKey key) => key.InsertTextIntoDocumentation))
{
return;
}
DeclarationHeader declarationHeader = new DeclarationHeader(constructorDeclaration);
if (declarationHeader.IsMissing || declarationHeader.IsInherited || !declarationHeader.HasSummary)
{
return;
}
string existingSummaryText = declarationHeader.SummaryXmlNode.InnerXml;
bool parentIsStruct = Utils.IsContainingTypeAStruct(constructorDeclaration);
int constructorParameterCount = constructorDeclaration.ParameterDeclarations.Count;
string xmlComment = Utils.GetTextFromDeclarationHeader(declarationHeader.XmlNode);
string structOrClass = parentIsStruct ? CachedCodeStrings.StructText : CachedCodeStrings.ClassText;
string textWeShouldStartWith;
if (constructorDeclaration.IsStatic)
{
textWeShouldStartWith = string.Format(
CultureInfo.InvariantCulture, CachedCodeStrings.HeaderSummaryForStaticConstructor, constructorDeclaration.DeclaredName, structOrClass);
}
else if (constructorDeclaration.GetAccessRights() == AccessRights.PRIVATE && constructorParameterCount == 0)
{
textWeShouldStartWith = string.Format(
CultureInfo.InvariantCulture, CachedCodeStrings.HeaderSummaryForPrivateInstanceConstructor, constructorDeclaration.DeclaredName, structOrClass);
}
else
{
string constructorDescriptionText = Utils.CreateConstructorDescriptionText(constructorDeclaration, true);
textWeShouldStartWith = string.Format(
CultureInfo.InvariantCulture, CachedCodeStrings.HeaderSummaryForInstanceConstructor, constructorDescriptionText, structOrClass);
}
if (constructorDeclaration.IsStatic)
{
string docStd = string.Format("Initializes the {0} class.", constructorDeclaration.DeclaredName);
if (xmlComment == docStd)
{
existingSummaryText = string.Empty;
}
}
if (!xmlComment.StartsWith(textWeShouldStartWith, StringComparison.Ordinal))
{
string newSummaryText = Utils.CreateSummaryForConstructorDeclaration(constructorDeclaration);
declarationHeader.SummaryXmlNode.InnerXml = newSummaryText + " " + existingSummaryText;
declarationHeader.Update();
}
}
/// <summary>
/// Creates a new summary string for this constructor.
/// </summary>
/// <param name="constructorDeclaration">
/// The constructor to produce the summary for.
/// </param>
/// <returns>
/// A string of the constructor summary text.
/// </returns>
public static string CreateSummaryForConstructorDeclaration(IConstructorDeclaration constructorDeclaration)
{
DeclarationHeader declarationHeader = new DeclarationHeader(constructorDeclaration);
if (declarationHeader.IsInherited)
{
return declarationHeader.XmlNode.InnerXml;
}
IContextBoundSettingsStore settingsStore = PsiSourceFileExtensions.GetSettingsStore(null, constructorDeclaration.GetSolution());
if (!settingsStore.GetValue((StyleCopOptionsSettingsKey key) => key.InsertTextIntoDocumentation))
{
return string.Empty;
}
bool parentIsStruct = IsContainingTypeAStruct(constructorDeclaration);
string structOrClass = parentIsStruct ? "struct" : "class";
string xmlWeShouldInsert;
if (constructorDeclaration.IsStatic)
{
xmlWeShouldInsert = string.Format(CultureInfo.InvariantCulture, HeaderSummaryForStaticConstructorXml, constructorDeclaration.DeclaredName, structOrClass);
}
else if (constructorDeclaration.GetAccessRights() == AccessRights.PRIVATE && constructorDeclaration.ParameterDeclarations.Count == 0)
{
xmlWeShouldInsert = string.Format(
CultureInfo.InvariantCulture, HeaderSummaryForPrivateInstanceConstructorXml, constructorDeclaration.DeclaredName, structOrClass);
}
else
{
string constructorDescriptionText = CreateConstructorDescriptionText(constructorDeclaration, true);
xmlWeShouldInsert = string.Format(CultureInfo.InvariantCulture, HeaderSummaryForInstanceConstructorXml, constructorDescriptionText, structOrClass);
}
return xmlWeShouldInsert;
}
