StandardDocumentModel Class
Definition
- Namespace
- Sandcastle.Core.PresentationStyle
- Assembly
- Sandcastle.Core.dll
This is used to add the standard document model elements to the reflection information file
public class StandardDocumentModel : IApplyDocumentModel
- Inheritance
-
StandardDocumentModel
- Implements
Remarks
The generator has the following behaviors:
- If a root namespace container ID is specified, a root namespace container API entry (R:) is added with a list of the namespaces. If not specified, it is omitted.
- A
topicdataelement is added to each API entry to identify the topic group. For enumeration members (the fields), anotopicattribute is added to indicate that it should not get a separate topic. For explicitly implemented members, aneiinameattribute is added to identify the explicitly implemented type and member name. libraryelements are updated with the assembly version and, for type members, aNoAptcaelement is added if the assembly does not allow partially trusted callers.- Elements for overloaded methods are grouped into Overload elements within their type's API
entry. Extension methods are not grouped if overloaded but do get an
overloadattribute. - The API entries for overloaded members have an
overloadattribute added to theirmemberdataelement to identify the overload topic ID. - For all types except enumerations, member list topic API entries are created for methods, operators, properties, events, fields, attached properties, attached events, and overloaded members.
Properties
| RootNamespaceContainerId |
This is used to get or set an optional root namespace container ID |
Methods
| ApplyDocumentModel(string, string) |
This is used to apply the document model to a reflection information file |