StandardApiTocGenerator Class
This is used to generate a standard table of contents for API content
Namespace: Sandcastle.Core.PresentationStyleAssembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.12.21.0
public class StandardApiTocGenerator : IApiTocGenerator
Public Class StandardApiTocGenerator
Implements IApiTocGenerator
public ref class StandardApiTocGenerator : IApiTocGenerator
type StandardApiTocGenerator =
class
interface IApiTocGenerator
end
- Inheritance
- Object StandardApiTocGenerator
- Implements
- IApiTocGenerator
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.
ListTopicOrder |
This is used to get or set the list topic order in the table of contents
|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
GenerateApiTocFile |
This is used to generate a table of contents file for API content
|
GetHashCode | Serves as the default hash function. (Inherited from Object) |
GetType | Gets the Type of the current instance. (Inherited from Object) |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
ToString | Returns a string that represents the current object. (Inherited from Object) |