@@ -6,10 +6,29 @@ namespace DotNetApiDiff.Models;
66/// </summary>
77public enum ChangeType
88{
9+ /// <summary>
10+ /// Indicates a new API element was added
11+ /// </summary>
912 Added ,
13+
14+ /// <summary>
15+ /// Indicates an API element was removed
16+ /// </summary>
1017 Removed ,
18+
19+ /// <summary>
20+ /// Indicates an API element was modified
21+ /// </summary>
1122 Modified ,
23+
24+ /// <summary>
25+ /// Indicates an API element was moved to a different location
26+ /// </summary>
1227 Moved ,
28+
29+ /// <summary>
30+ /// Indicates an API element was excluded from the comparison
31+ /// </summary>
1332 Excluded ,
1433}
1534
@@ -18,13 +37,44 @@ public enum ChangeType
1837/// </summary>
1938public enum ApiElementType
2039{
40+ /// <summary>
41+ /// Represents an assembly element
42+ /// </summary>
2143 Assembly ,
44+
45+ /// <summary>
46+ /// Represents a namespace element
47+ /// </summary>
2248 Namespace ,
49+
50+ /// <summary>
51+ /// Represents a type element (class, interface, struct, etc.)
52+ /// </summary>
2353 Type ,
54+
55+ /// <summary>
56+ /// Represents a method element
57+ /// </summary>
2458 Method ,
59+
60+ /// <summary>
61+ /// Represents a property element
62+ /// </summary>
2563 Property ,
64+
65+ /// <summary>
66+ /// Represents a field element
67+ /// </summary>
2668 Field ,
69+
70+ /// <summary>
71+ /// Represents an event element
72+ /// </summary>
2773 Event ,
74+
75+ /// <summary>
76+ /// Represents a constructor element
77+ /// </summary>
2878 Constructor ,
2979}
3080
@@ -33,15 +83,54 @@ public enum ApiElementType
3383/// </summary>
3484public enum MemberType
3585{
86+ /// <summary>
87+ /// Represents a class type
88+ /// </summary>
3689 Class ,
90+
91+ /// <summary>
92+ /// Represents an interface type
93+ /// </summary>
3794 Interface ,
95+
96+ /// <summary>
97+ /// Represents a structure type
98+ /// </summary>
3899 Struct ,
100+
101+ /// <summary>
102+ /// Represents an enumeration type
103+ /// </summary>
39104 Enum ,
105+
106+ /// <summary>
107+ /// Represents a delegate type
108+ /// </summary>
40109 Delegate ,
110+
111+ /// <summary>
112+ /// Represents a method member
113+ /// </summary>
41114 Method ,
115+
116+ /// <summary>
117+ /// Represents a property member
118+ /// </summary>
42119 Property ,
120+
121+ /// <summary>
122+ /// Represents a field member
123+ /// </summary>
43124 Field ,
125+
126+ /// <summary>
127+ /// Represents an event member
128+ /// </summary>
44129 Event ,
130+
131+ /// <summary>
132+ /// Represents a constructor member
133+ /// </summary>
45134 Constructor ,
46135}
47136
@@ -50,11 +139,34 @@ public enum MemberType
50139/// </summary>
51140public enum AccessibilityLevel
52141{
142+ /// <summary>
143+ /// Accessible only within the containing type
144+ /// </summary>
53145 Private ,
146+
147+ /// <summary>
148+ /// Accessible within the containing type and derived types
149+ /// </summary>
54150 Protected ,
151+
152+ /// <summary>
153+ /// Accessible within the containing assembly
154+ /// </summary>
55155 Internal ,
156+
157+ /// <summary>
158+ /// Accessible within the containing assembly and derived types in any assembly
159+ /// </summary>
56160 ProtectedInternal ,
161+
162+ /// <summary>
163+ /// Accessible within the containing type and derived types within the same assembly
164+ /// </summary>
57165 ProtectedPrivate ,
166+
167+ /// <summary>
168+ /// Accessible without restrictions
169+ /// </summary>
58170 Public ,
59171}
60172
@@ -63,9 +175,24 @@ public enum AccessibilityLevel
63175/// </summary>
64176public enum SeverityLevel
65177{
178+ /// <summary>
179+ /// Informational change with no impact on compatibility
180+ /// </summary>
66181 Info ,
182+
183+ /// <summary>
184+ /// Change that may impact compatibility in some scenarios
185+ /// </summary>
67186 Warning ,
187+
188+ /// <summary>
189+ /// Change that will likely break compatibility
190+ /// </summary>
68191 Error ,
192+
193+ /// <summary>
194+ /// Change that will definitely break compatibility in a significant way
195+ /// </summary>
69196 Critical ,
70197}
71198
@@ -74,9 +201,28 @@ public enum SeverityLevel
74201/// </summary>
75202public enum ReportFormat
76203{
204+ /// <summary>
205+ /// Output report to console in a readable text format
206+ /// </summary>
77207 Console ,
208+
209+ /// <summary>
210+ /// Output report in JSON format
211+ /// </summary>
78212 Json ,
213+
214+ /// <summary>
215+ /// Output report in XML format
216+ /// </summary>
79217 Xml ,
218+
219+ /// <summary>
220+ /// Output report in HTML format
221+ /// </summary>
80222 Html ,
223+
224+ /// <summary>
225+ /// Output report in Markdown format
226+ /// </summary>
81227 Markdown ,
82228}
0 commit comments