public virtual void WriteParametersSection(int level, DocumentFormatter output, OutputContext context, IEnumerable <ParameterInfo> parameters)
{
if (parameters == null || !parameters.Any())
{
return;
}
var doc = context.Document.Of(this);
output.Header(level, "Parameters");
output.DefinitionList(parameters,
parameter =>
{
output.Text(parameter.Name, TextStyles.Teletype);
output.Text(": ");
if (parameter.ParameterType.IsGenericParameter)
{
output.Text(parameter.ParameterType.GetDisplayName(), TextStyles.Emphasize);
}
else
{
output.LinkCRef(parameter.ParameterType.GetCRef(), parameter.ParameterType.GetDisplayName());
}
},
parameter => output.Section(() => doc?.Parameters.For(parameter.Name, output.Xml, name => Log.WarnMisisngParameterDoc(this, name))));
}
public virtual void WriteInfoBox(DocumentFormatter output, OutputContext context)
{
output.Quote(GetInfoBoxWriters(context), info =>
{
output.Text(info.Label);
output.Text(": ");
info.Writer(output);
});
}
public override void WriteMembers(int level, DocumentFormatter output, OutputContext context)
{
output.Header(level, "Members");
output.Table(new[] { "Name", "Value", "Description" }, Info.GetEnumValues().Cast <Enum>(),
value => output.Text(Info.GetEnumName(value)),
value => output.Text((value as IFormattable)?.ToString("D", CultureInfo.InvariantCulture)),
value => context.Document.Members.For(value.GetCRef(), doc => output.Xml(doc.Summaries.FirstOrDefault()))
);
}
protected virtual void WriteSection(DocumentFormatter output, int level, string header, IEnumerable <XmlRevisionHistory> items)
{
var revisions = items?.Where(item => item.IsVisible).SelectMany(item => item.Revisions.Where(revision => revision.IsVisible));
if (revisions == null || !revisions.Any())
{
return;
}
if (!string.IsNullOrEmpty(header))
{
output.Header(level, header);
}
output.Table(new[] { "Date", "Version", "Author", "Description" }, revisions,
revision => output.Text(revision.Date),
revision => output.Text(revision.Version),
revision => output.Text(revision.Author),
revision => output.Xml(revision));
}
protected virtual void WriteSection(DocumentFormatter output, int level, string header, string label, IEnumerable <XmlNamedNode> items)
{
if (items == null || !items.Any())
{
return;
}
if (!string.IsNullOrEmpty(header))
{
output.Header(level, header);
}
output.Table(new[] { label, "Description" }, items,
item => output.Text(item.Name),
item => output.Xml(item));
}
public virtual void WriteTypeParametersSection(int level, DocumentFormatter output, OutputContext context, IEnumerable <Type> typeParameters)
{
if (typeParameters == null || !typeParameters.Any())
{
return;
}
var doc = context.Document.Of(this);
output.Header(level, "Type Parameters");
output.DefinitionList(typeParameters,
typeParameter => output.Text(typeParameter.Name, TextStyles.Teletype),
typeParameter => output.Section(() =>
{
if (WriteTypeParamDoc(doc, typeParameter.Name))
{
return;
}
if (!typeParameter.IsGenericMethodParameter)
{
for (var parent = Owner; parent != null; parent = parent.Owner)
{
if (WriteTypeParamDoc(context.Document.Of(parent), typeParameter.Name))
{
return;
}
}
}
Log.WarnMisisngTypeParameterDoc(this, typeParameter.Name);
}));
bool WriteTypeParamDoc(XmlMember ownerDoc, string paramName)
{
if (ownerDoc != null && ownerDoc.TypeParameters.TryGetValue(paramName, out var paramDoc))
{
output.Xml(paramDoc);
return(true);
}
return(false);
}
}
protected virtual void WriteDefaultSummary(DocumentFormatter output, OutputContext context)
{
output.Text("Initializes a new instance of ");
Owner.WriteLink(output, context);
output.Text(" ", Owner.Category.ToString().ToLower(), ".");
}
