-
Notifications
You must be signed in to change notification settings - Fork 365
/
ApiTopicSectionType.cs
122 lines (120 loc) · 4.92 KB
/
ApiTopicSectionType.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
//===============================================================================================================
// System : Sandcastle Tools - Sandcastle Tools Core Class Library
// File : ApiTopicSectionType.cs
// Author : Eric Woodruff (Eric@EWoodruff.us)
// Updated : 03/26/2022
// Note : Copyright 2022, Eric Woodruff, All rights reserved
//
// This file contains an enumerated type that defines the sections that are rendered in an API topic
//
// This code is published under the Microsoft Public License (Ms-PL). A copy of the license should be
// distributed with the code and can be found at the project website: https://GitHub.com/EWSoftware/SHFB. This
// notice, the author's name, and all copyright notices must remain intact in all applications, documentation,
// and source files.
//
// Date Who Comments
// ==============================================================================================================
// 03/11/2022 EFW Created the code
//===============================================================================================================
using System;
namespace Sandcastle.Core.PresentationStyle.Transformation
{
/// <summary>
/// This enumerated type defines the sections that are rendered in an API topic
/// </summary>
/// <remarks>Section order may vary from one presentation style to another and may be customized by plug-ins</remarks>
[Serializable]
public enum ApiTopicSectionType
{
/// <summary>
/// The notices such as the preliminary API and obsolete warnings
/// </summary>
/// <remarks>This is typically rendered at the very top of the topic.</remarks>
Notices,
/// <summary>
/// The summary section.
/// </summary>
/// <remarks>For overload topics, the summary will come from the first <c>overloads</c> element.</remarks>
Summary,
/// <summary>
/// The abbreviated inheritance hierarchy.
/// </summary>
/// <remarks> This is typically used in conjunction with <see cref="InheritanceHierarchyFull" /> with
/// the abbreviated hierarchy appearing at the top of the topic and the full hierarchy appearing at the
/// end of the topic if needed if the descendant count exceeds the abbreviated threshold (four
/// descendants). In such cases, the abbreviated hierarchy will have a "More..." link to it.</remarks>
InheritanceHierarchyAbbreviated,
/// <summary>
/// Namespace and assembly information.
/// </summary>
/// <remarks>Only API member pages get namespace and assembly info.</remarks>
NamespaceAndAssemblyInfo,
/// <summary>
/// The syntax section.
/// </summary>
/// <remarks>Only API member pages get a syntax section. This includes the declaration syntax,
/// parameters, templates, return value, and implemented member information.</remarks>
SyntaxSection,
/// <summary>
/// A member list based on the topic type (root, root group, namespace group, namespace, enumeration,
/// type, or type members).
/// </summary>
MemberList,
/// <summary>
/// The events section.
/// </summary>
Events,
/// <summary>
/// The exceptions section.
/// </summary>
Exceptions,
/// <summary>
/// The remarks section.
/// </summary>
/// <remarks>For overload topics, the remarks will come from the first <c>overloads</c> element.</remarks>
Remarks,
/// <summary>
/// The examples section.
/// </summary>
/// <remarks>For overload topics, the examples will come from the first <c>overloads</c> element.</remarks>
Examples,
/// <summary>
/// The platforms section (reserved for future use).
/// </summary>
Platforms, // TODO: Remove reserved note when implemented
/// <summary>
/// The versions section.
/// </summary>
/// <remarks>Only API member pages get version information.</remarks>
Versions,
/// <summary>
/// The permissions section.
/// </summary>
Permissions,
/// <summary>
/// The thread safety section.
/// </summary>
ThreadSafety,
/// <summary>
/// The revision history section.
/// </summary>
RevisionHistory,
/// <summary>
/// The bibliography section.
/// </summary>
Bibliography,
/// <summary>
/// The See Also section.
/// </summary>
SeeAlso,
/// <summary>
/// The full inheritance hierarchy.
/// </summary>
InheritanceHierarchyFull,
/// <summary>
/// A custom section.
/// </summary>
/// <remarks>This can be used by plug-ins to add new sections to an API topic.</remarks>
CustomSection
}
}