XmlDocEntry Class

Namespace
Kampute.DocToolkit.XmlDoc
Assembly
  • Kampute.DocToolkit.dll

Definition

Represents XML documentation for a namespace, type, or type member.
public class XmlDocEntry
Inheritance

Remarks

Provides structured access to XML documentation comments extracted from source code. Parses standard XML documentation tags for consumption by documentation generators.

Each instance represents complete documentation for a single code element and provides lazy-loaded access to documentation sections.

Thread Safety

All public members of the type are guaranteed to be thread-safe.

Constructors

XmlDocEntry(XElement)Initializes a new instance of the XmlDocEntry class.
XmlDocEntry(XmlDocEntry, IDocumentationContext)Initializes a new instance associated with the specified documentation context.

Fields

EmptyRepresents an empty documentation instance.

Properties

ContextGets the documentation context associated with this instance.
EventsGets events that might be raised.
ExampleGets the usage example.
ExceptionsGets exceptions that might be thrown.
IsEmptyGets a value indicating whether the documentation is empty.
OverloadsGets common documentation for overloads.
ParametersGets parameter descriptions.
PermissionsGets required permissions.
RemarksGets the remarks.
ReturnDescriptionGets the return value description.
SeeAlsoGets related references.
SummaryGets the summary.
ThreadSafetyGets thread safety information.
TypeParametersGets type parameter descriptions.
ValueDescriptionGets the value description for properties.
XmlElementGets the underlying XML element.

Methods

WithContext(IDocumentationContext)Creates a copy associated with the specified documentation context.

Extension Methods

Inspect(this XmlDocEntry, IMember, XmlDocInspectionOptions, Func<IMember, XmlDocEntry>)Inspects the XML documentation entry for missing or incomplete elements based on the provided member and inspection options.

See Also