IDocumentModel Interface
- Namespace
- Kampute.DocToolkit
- Assembly
- Kampute.DocToolkit.dll
Definition
Defines a contract for a model in the documentation that can be rendered with a specific context.
public interface IDocumentModel- Implemented by
Remarks
This interface serves as a base for all models that are part of the documentation system. It provides properties to access the documentation context and the URL for the model. Implementing this interface allows the model to be rendered with the appropriate context and provides a way to link to the model's documentation page.
Properties
| Context | Gets the documentation context associated with the model. |
| HierarchyPath | Gets the hierarchy of parent models that lead to this model. |
| IsApiModel | Gets a value indicating whether this model represents an API model. |
| ModelType | Gets the type of the documentation model. |
| Name | Gets the display name or title of the model. |
| Url | Gets the documentation URL for the model. |
Methods
| TryGetDocumentationFile(out string) | Attempts to get the relative path of the documentation file for the model. |