Comment Class
- Namespace
- Kampute.DocToolkit.XmlDoc.Comments
- Assembly
- Kampute.DocToolkit.dll
Definition
Represents the documentation content for a top-level XML comment.
public class Comment- Inheritance
- object
- Comment
- Inherited by
Remarks
The Comment class serves as the fundamental representation of XML documentation content for a top-level XML comment. It encapsulates the XML element that contains the documentation and provides methods for transforming the content into a string representation.
Thread Safety
All public members of the type are guaranteed to be thread-safe.
Constructors
| Comment(XElement) | Initializes a new instance of the Comment class. |
Fields
| Empty | Represents an empty comment. |
Properties
| Content | Gets the underlying XML element containing the documentation content. |
| IsEmpty | Gets a value indicating whether the comment is without content. |
Methods
| Collect(IEnumerable<XElement>) | Collects all comments that are associated with a name from the specified XML elements. |
| Create(XElement) | Creates a comment from the specified XML element. |
| ToString() | Converts the comment to its string representation without formatting. |
| ToString(IXmlDocTransformer) | Converts the XML comment to its string representation using the specified formatter. |