protected virtual void WriteOverloadsSummary(DocumentFormatter output, OutputContext context) { var doc = Overloads.Select(o => context.Document.Of(o)?.Overloads.FirstOrDefault()).FirstOrDefault(o => o != null); if (doc != null) { if (doc.Summaries.Any()) { output.Xml(doc.Summaries); } else { output.Section(() => output.Xml(doc)); } } }
public override void WriteSummary(DocumentFormatter output, OutputContext context) { var summary = context.Document.Of(this)?.Summaries; if (summary != null && summary.Count != 0) { output.Section(() => output.Xml(summary)); } else { output.Section(() => WriteDefaultSummary(output, context)); } }
public override void WriteSummaryLine(DocumentFormatter output, OutputContext context) { var summary = context.Document.Of(this)?.Summaries.FirstOrDefault(); if (summary != null) { output.Xml(summary); } else { WriteDefaultSummary(output, context); } }
protected virtual void WriteSection(DocumentFormatter output, int level, string header, IEnumerable <XmlNode> items) { if (items == null || !items.Any()) { return; } if (!string.IsNullOrEmpty(header)) { output.Header(level, header); } output.Xml(items); }
protected virtual void WriteSection(DocumentFormatter output, int level, string header, string label, IEnumerable <XmlReferenceNode> items) { if (items == null || !items.Any()) { return; } if (!string.IsNullOrEmpty(header)) { output.Header(level, header); } output.Table(new[] { label, "Description" }, items, item => output.LinkCRef(item.CRef, Utils.FormatCRef(item.CRef)), 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); } }
public virtual void WriteReturnValueSection(int level, DocumentFormatter output, OutputContext context, Type returnType) { if (returnType == null || returnType == typeof(void)) { return; } var doc = context.Document.Of(this); if (doc != null && doc.Returns.Count == 0) { Log.WarnMisisngReturnDoc(this); } output.Header(level, "Return Value"); output.DefinitionList(new[] { returnType }, type => output.LinkCRef(type.GetCRef(), type.GetDisplayName()), type => output.Xml(doc?.Returns)); }
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)); }
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())) ); }
public virtual void WriteSummary(DocumentFormatter output, OutputContext context) { output.Xml(context.Document.Of(this)?.Summaries); }