StandardApiTocGenerator Class
Definition
- Namespace
- Sandcastle.Core.PresentationStyle
- Assembly
- Sandcastle.Core.dll
This is used to generate a standard table of contents for API content
public class StandardApiTocGenerator : IApiTocGenerator
- Inheritance
-
StandardApiTocGenerator
- Implements
Remarks
The generator has the following behaviors:
- The reflection information is assumed to contain list entries for properties, methods, events, etc. These are used to generate corresponding list topic entries in the table of contents.
- A root namespace container (R:) is supported if present.
- Namespace grouping is supported if grouping elements (G:) are present.
- Overloads are assumed to have a container topic and each overload has its own subtopic below it.
- Namespaces, types, and members are sorted in ascending order by name. Explicit interface implementations are list ahead of the type's other members sorted by member name. Overloads are sorted by parameter count and then by the type name of the first parameter.
- The default order of the member list topics is properties, methods, events, operators, fields, attached properties, and finally attached events.
Properties
| ListTopicOrder |
This is used to get or set the list topic order in the table of contents |
Methods
| GenerateApiTocFile(string, string) |
This is used to generate a table of contents file for API content |