SeeAlsoComment Class
- Namespace
- Kampute.DocToolkit.XmlDoc.Comments
- Assembly
- Kampute.DocToolkit.dll
Definition
Represents the documentation content for a see-also reference, which is associated with a code reference or hyperlink.
public class SeeAlsoComment : CommentRemarks
Thread Safety
All public members of the type are guaranteed to be thread-safe.
Constructors
| SeeAlsoComment(string, XElement) | Initializes a new instance of the SeeAlsoComment class for a code reference. |
Properties
| IsCodeReference | Gets a value indicating whether the reference is a code reference. |
| IsHyperlink | Gets a value indicating whether the reference is a hyperlink. |
| Target | Gets the code reference (cref) or hyperlink (href) being referenced. |
Methods
| Collect(IEnumerable<XElement>) | Collects all see-also references from the specified XML elements. |
| TryCreate(XElement, out SeeAlsoComment) | Attempts to create a new instance of the SeeAlsoComment class from the specified XML element. |
| WithResolvedHyperlink(IDocumentationContext) | Returns a new version of this see-also comment with resolved cross-reference and description, if its reference is a relative URL. |
<seealso>XML documentation tag, which is used to create cross-references between documentation topics. These can link to other code elements using a code reference (cref) or to external resources using hyperlinks (href).