ReferenceComment Class

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

Definition

Represents a documentation content that is associated with a code reference.
public class ReferenceComment : Comment
Inheritance

Remarks

The ReferenceComment class processes XML documentation tags that contain references to other code elements, such as <exception> tags. These references allow documentation to create links between related elements in the generated documentation.

Thread Safety

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

Constructors

ReferenceComment(string, XElement)Initializes a new instance of the ReferenceComment class.

Properties

ReferenceGets the code reference being described.
VariantsGets any additional XML elements that provide variants or supplementary documentation content for this reference.

Methods

Collect(IEnumerable<XElement>)Collects all references from the specified XML elements, preserving the order of first occurrence.
TryCreate(XElement, out ReferenceComment)Attempts to create a new instance of the ReferenceComment class from the specified XML element.