- Document
Document
Namespace: Shared.Docs
Assembly: SharedLib
Contains documentation for a class/type or custom documentationConstructors
| #ctor(Shared.DocumentType) | Constructor Other document types (Custom etc) |
| #ctor(String) | Constructor Used when documenting an assembly |
| #ctor(Shared.DocumentType,String,String,String) | Constructor Used when documenting a class/type |
Properties
| Title | Document Title |
| AcquisitionMethod | How class can be acquired (DI etc) |
| ClassName | Name of class |
| Summary | Summary for class |
| Remarks | Any remarkable information for class |
| Returns | Return Value if required |
| Value | Value if required |
| Example | Example |
| Constructors | Documented Construcors |
| Methods | Documented Methods |
| Properties | Documented Properties |
| Fields | Documented Fields |
| SortOrder | Sort order to be used for this item |
| ExampleUseage | Text for example useage |
| Tag | Custom object for use by implementing class to hold any data. |