Interface IDocumented

This interface must be implemented by all classes that support documentation of their objects.

Namespace: Quantellia.WMServer.Base

Assembly: WMServer.dll

Syntax

public interface IDocumented

Properties

Documentation

Long-form documentation of this object. May be encoded by the MIME type specified in the DocumentationMIMEType property.

Declaration

string? Documentation { get; set; }

Property Value

Type	Description
string

DocumentationMIMEType

MIME type of the data in the Documentation property.

Declaration

string? DocumentationMIMEType { get; set; }

Property Value

Type	Description
string

Summary

A short summary string describing this object.

Declaration

string? Summary { get; set; }

Property Value

Type	Description
string