void IPolicyConfigControl.WriteToConfig(PolicyConfig config)
{
DelegateConfig controlConfig = config.DelegateConfig;
controlConfig.VisibilitiesToCheck = Visibilities.GetVisibilites();
controlConfig.GenericParameterDocumentationRequired = GenericParametersOptionCheckBox.Checked;
controlConfig.ParameterDocumentationRequired = ParametersOptionCheckBox.Checked;
controlConfig.ResultDocumentationRequired = ReturnsDocumentationTagCheckBox.Checked;
controlConfig.SampleDocumentationRequired = SampleDocumentationTagCheckBox.Checked;
controlConfig.SummaryDocumentationRequired = SummaryDocumentationTagCheckBox.Checked;
}
protected override void ProcessInternal(INamedTypeSymbol symbol, PolicyConfig policyConfig, IViolationReporter violationReporter)
{
DelegateConfig config = policyConfig.DelegateConfig;
if (!AnyVisibilityMatches(symbol.DeclaredAccessibility, config.VisibilitiesToCheck))
{
return;
}
if (symbol.DelegateInvokeMethod == null)
{
return;
}
IDocumentationComment documentation = symbol.GetDocumentationComment();
if (config.SampleDocumentationRequired && string.IsNullOrWhiteSpace(documentation.ExampleText))
{
violationReporter.Report(ViolationFromSymbol(ViolationMessage.MissingSampleDocumentation, symbol));
}
if (config.SummaryDocumentationRequired && string.IsNullOrWhiteSpace(documentation.SummaryText))
{
violationReporter.Report(ViolationFromSymbol(ViolationMessage.MissingSummaryDocumentation, symbol));
}
if (config.ResultDocumentationRequired && !symbol.DelegateInvokeMethod.ReturnsVoid && string.IsNullOrWhiteSpace(documentation.ReturnsText))
{
violationReporter.Report(ViolationFromSymbol(ViolationMessage.MissingReturnsDocumentation, symbol));
}
if (config.ParameterDocumentationRequired && !symbol.DelegateInvokeMethod.Parameters.IsEmpty)
{
foreach (IParameterSymbol parameterSymbol in symbol.DelegateInvokeMethod.Parameters)
{
if (string.IsNullOrWhiteSpace(documentation.GetParameterText(parameterSymbol.Name)))
{
violationReporter.Report(ViolationFromSymbol(string.Format(ViolationMessage.MissingParameter, parameterSymbol.Name), symbol));
}
}
}
if (config.GenericParameterDocumentationRequired && !symbol.TypeParameters.IsEmpty)
{
foreach (ITypeParameterSymbol typeParameter in symbol.TypeParameters)
{
if (string.IsNullOrWhiteSpace(documentation.GetTypeParameterText(typeParameter.Name)))
{
violationReporter.Report(ViolationFromSymbol(string.Format(ViolationMessage.MissingTypeParameter, typeParameter.Name), symbol));
}
}
}
}
void IPolicyConfigControl.ReadFromConfig(PolicyConfig config)
{
DelegateConfig controlConfig = config.DelegateConfig;
Visibilities.Bind(controlConfig.VisibilitiesToCheck);
GenericParametersOptionCheckBox.Checked = controlConfig.GenericParameterDocumentationRequired;
ParametersOptionCheckBox.Checked = controlConfig.ParameterDocumentationRequired;
ReturnsDocumentationTagCheckBox.Checked = controlConfig.ResultDocumentationRequired;
SampleDocumentationTagCheckBox.Checked = controlConfig.SampleDocumentationRequired;
SummaryDocumentationTagCheckBox.Checked = controlConfig.SummaryDocumentationRequired;
}
