-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathNETMetaCoder.xml
More file actions
564 lines (556 loc) · 32.1 KB
/
Copy pathNETMetaCoder.xml
File metadata and controls
564 lines (556 loc) · 32.1 KB
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
<?xml version="1.0"?>
<doc>
<assembly>
<name>NETMetaCoder</name>
</assembly>
<members>
<member name="T:NETMetaCoder.CodeTransformationResult">
<summary>
The result of making a code transformation pass through a compilation unit.
</summary>
</member>
<member name="P:NETMetaCoder.CodeTransformationResult.TransformationOccured">
<summary>
True is the code in the processed compilation unit was transformed.
</summary>
</member>
<member name="P:NETMetaCoder.CodeTransformationResult.MirrorFilePath">
<summary>
The file path to the rewritten code file, which holds the original code of the compilation unit.
</summary>
</member>
<member name="P:NETMetaCoder.CodeTransformationResult.CompanionFilePath">
<summary>
The file path to the companion code file, which holds the newly produced code, that serves as a proxy to the
functionality of the compilation unit.
</summary>
</member>
<member name="T:NETMetaCoder.CodeTransformer">
<summary>
This class provides the core functionality of the library.
It's focal point is method <see cref="M:NETMetaCoder.CodeTransformer.Wrap(System.String)"/> which is responsible for running the code wrapping logic for a
compilation unit.
</summary>
<seealso cref="T:NETMetaCoder.CodeWrapTransformationOptions"/>
<seealso cref="T:NETMetaCoder.SyntaxScanner"/>
<seealso cref="T:NETMetaCoder.SyntaxRewriter"/>
</member>
<member name="M:NETMetaCoder.CodeTransformer.#ctor(NETMetaCoder.CodeWrapTransformationOptions,System.Boolean)">
<summary>
Creates a new <see cref="T:NETMetaCoder.CodeTransformer"/> instance.
</summary>
<param name="options"></param>
<param name="writeOutput"></param>
<seealso cref="T:NETMetaCoder.CodeWrapTransformationOptions"/>
</member>
<member name="M:NETMetaCoder.CodeTransformer.Wrap(System.String)">
<summary>
This function receives a file path and potentially produces a code syntax transformation of that file's
code.
</summary>
<param name="filePath"></param>
<remarks>
This method takes the following steps:
1. Is parses its syntax tree.
2. It scans the parsed syntax tree into a <see cref="N:NETMetaCoder.SyntaxEnvelope"/>, keeping only the parts relevant to
the functionality of this library.
3. If the file needs to be rewritten, then the original file is changed so that its code can be wrapped and
companion file with the wrapping code is created.
</remarks>
<seealso cref="T:NETMetaCoder.SyntaxScanner"/>
<seealso cref="T:NETMetaCoder.SyntaxRewriter"/>
</member>
<member name="T:NETMetaCoder.CodeWrapTransformationOptions">
<summary>
This type represents the options passed to <see cref="T:NETMetaCoder.CodeTransformer"/>, in order to process a compilation
unit.
</summary>
<seealso cref="T:NETMetaCoder.CodeTransformer"/>
</member>
<member name="M:NETMetaCoder.CodeWrapTransformationOptions.#ctor(System.String,System.String,System.String,System.Collections.Immutable.IImmutableDictionary{NETMetaCoder.Abstractions.AttributeDescriptor,System.ValueTuple{Microsoft.CodeAnalysis.SyntaxList{Microsoft.CodeAnalysis.CSharp.Syntax.UsingDirectiveSyntax},NETMetaCoder.Abstractions.PropertySyntaxGenerator,System.Collections.Immutable.IImmutableList{NETMetaCoder.Abstractions.SyntaxWrapper}}},System.String)">
<summary>
Constructs a new <see cref="T:NETMetaCoder.CodeWrapTransformationOptions"/> instance.
</summary>
<param name="fileBasePath"></param>
<param name="outputBasePath"></param>
<param name="outputDirectoryName"></param>
<param name="syntaxPerAttribute"></param>
<param name="eol"></param>
</member>
<member name="P:NETMetaCoder.CodeWrapTransformationOptions.OutputBasePath">
<summary>
The path to a directory where the <see cref="P:NETMetaCoder.CodeWrapTransformationOptions.OutputDirectoryName"/> directory will be created and the output
of <see cref="M:NETMetaCoder.CodeTransformer.Wrap(System.String)"/> will be stored.
</summary>
<seealso cref="P:NETMetaCoder.CodeWrapTransformationOptions.OutputDirectoryName"/>
</member>
<member name="P:NETMetaCoder.CodeWrapTransformationOptions.OutputDirectoryName">
<summary>
The name of the directory in <see cref="P:NETMetaCoder.CodeWrapTransformationOptions.OutputBasePath"/>, where the output of
<see cref="M:NETMetaCoder.CodeTransformer.Wrap(System.String)"/> will be stored.
</summary>
<seealso cref="P:NETMetaCoder.CodeWrapTransformationOptions.OutputBasePath"/>
</member>
<member name="P:NETMetaCoder.CodeWrapTransformationOptions.FileBasePath">
<summary>
The path to the directory where the search for <c>*.cs</c> files will be made.
</summary>
</member>
<member name="P:NETMetaCoder.CodeWrapTransformationOptions.EndOfLine">
<summary>
The EOL character sequence to use for the generated code files.
</summary>
</member>
<member name="P:NETMetaCoder.CodeWrapTransformationOptions.AttributeNames">
<summary>
The names of the targeted attributes which will cause a compilation unit to be rewritten.
</summary>
</member>
<member name="P:NETMetaCoder.CodeWrapTransformationOptions.Usings">
<summary>
The using declarations to write in the rewritten compilation unit.
</summary>
</member>
<member name="P:NETMetaCoder.CodeWrapTransformationOptions.PropertySyntaxGenerators">
<summary>
Anonymous functions, keyed by an attribute name, that produce property declaration syntax nodes.
The produces properties are part of the code that wraps calls to methods of the compilation unit.
</summary>
<seealso cref="T:NETMetaCoder.Abstractions.PropertySyntaxGenerator"/>
</member>
<member name="P:NETMetaCoder.CodeWrapTransformationOptions.PreExpressionMappers">
<summary>
Anonymous functions, keyed by an attribute name, that produce the new syntax with which a method is wrapped.
</summary>
<remarks>
The syntax produced by these is place before the call to the wrapped method.
Together with <see cref="P:NETMetaCoder.CodeWrapTransformationOptions.PostExpressionMappers"/>, they wrap the call to the wrapped method.
</remarks>
<seealso cref="T:NETMetaCoder.Abstractions.MethodSyntaxGenerator"/>
</member>
<member name="P:NETMetaCoder.CodeWrapTransformationOptions.PostExpressionMappers">
<summary>
Anonymous functions, keyed by an attribute name, that produce the new syntax with which a method is wrapped.
</summary>
<remarks>
The syntax produced by these is place after the call to the wrapped method.
Together with <see cref="P:NETMetaCoder.CodeWrapTransformationOptions.PreExpressionMappers"/>, they wrap the call to the wrapped method.
</remarks>
<seealso cref="T:NETMetaCoder.Abstractions.MethodSyntaxGenerator"/>
</member>
<member name="P:NETMetaCoder.CodeWrapTransformationOptions.OutputDirectory">
<summary>
The path to a directory, as a combination of <see cref="P:NETMetaCoder.CodeWrapTransformationOptions.OutputBasePath"/> and
<see cref="P:NETMetaCoder.CodeWrapTransformationOptions.OutputDirectoryName"/>, where the rewritten code files will be stored.
</summary>
</member>
<member name="M:NETMetaCoder.CodeWrapTransformationOptions.SelectUsings(System.Collections.Immutable.ImmutableHashSet{System.String})">
<summary>
Selects using declaration syntax nodes from <see cref="P:NETMetaCoder.CodeWrapTransformationOptions.Usings"/>, based on a list of attribute names.
</summary>
<param name="attributeNames"></param>
</member>
<member name="M:NETMetaCoder.CodeWrapTransformationOptions.SelectPropertySyntaxGenerators(System.Collections.Immutable.ImmutableHashSet{System.String})">
<summary>
Selects property declaration generators from <see cref="P:NETMetaCoder.CodeWrapTransformationOptions.PropertySyntaxGenerators"/>, based on a list of
attribute names.
</summary>
<param name="attributeNames"></param>
</member>
<member name="M:NETMetaCoder.CodeWrapTransformationOptions.SelectPreExpressionMappers(System.Collections.Immutable.ImmutableHashSet{System.String})">
<summary>
Selects expression syntax fragments from <see cref="P:NETMetaCoder.CodeWrapTransformationOptions.PreExpressionMappers"/>, based on a list of attribute
names.
</summary>
<param name="attributeNames"></param>
</member>
<member name="M:NETMetaCoder.CodeWrapTransformationOptions.SelectPostExpressionMappers(System.Collections.Immutable.ImmutableHashSet{System.String})">
<summary>
Selects expression syntax fragments from <see cref="P:NETMetaCoder.CodeWrapTransformationOptions.PostExpressionMappers"/>, based on a list of attribute
names.
</summary>
<param name="attributeNames"></param>
</member>
<member name="T:NETMetaCoder.Debug">
<summary>
Provides utilities meant only as a debugging tool, during development.
</summary>
</member>
<member name="M:NETMetaCoder.Debug.Print(NETMetaCoder.SyntaxEnvelope.SyntaxEnvelope)">
<summary>
Pretty prints a <see cref="N:NETMetaCoder.SyntaxEnvelope"/>.
</summary>
<param name="result"></param>
</member>
<member name="T:NETMetaCoder.PathHelper">
<summary>
A helper class for manipulating file paths.
</summary>
</member>
<member name="M:NETMetaCoder.PathHelper.GetRelativePath(System.String,System.String)">
<summary>
Get the path to a file, relative to another path.
</summary>
<param name="relativeTo"></param>
<param name="path"></param>
</member>
<member name="T:NETMetaCoder.StringExtensions">
<summary>
Extension methods for <see cref="T:System.String"/>, relevant to the requirements of this library.
</summary>
</member>
<member name="M:NETMetaCoder.StringExtensions.ToAttributeNameNeedle(System.String)">
<summary>
Transforms an attribute name so as to append it to a wrapped method's name.
</summary>
<param name="attributeName"></param>
<returns></returns>
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="T:NETMetaCoder.SyntaxBuilder">
<summary>
This type produces the syntax that wraps method calls in a compilation unit, based on a
<see cref="N:NETMetaCoder.SyntaxEnvelope"/>.
</summary>
</member>
<member name="M:NETMetaCoder.SyntaxBuilder.#ctor(NETMetaCoder.SyntaxEnvelope.SyntaxEnvelope,NETMetaCoder.CodeWrapTransformationOptions@)">
<summary>
Constructs a new <see cref="T:NETMetaCoder.SyntaxBuilder"/> instance.
</summary>
<param name="syntaxEnvelope"></param>
<param name="options"></param>
</member>
<member name="M:NETMetaCoder.SyntaxBuilder.Build">
<summary>
This method builds the syntax tree which wraps method calls in a compilation unit.
</summary>
<remarks>
The steps taken by this method are:
1. It instantiates a new syntax tree, which is an instance of <see cref="T:Microsoft.CodeAnalysis.CSharp.Syntax.CompilationUnitSyntax"/>, and it
traverses the syntax tree held by a <see cref="N:NETMetaCoder.SyntaxEnvelope"/>.
2. For each namespace, class and struct syntax node, it produces the relevant declaration syntax.
3. In the case when the <see cref="N:NETMetaCoder.SyntaxEnvelope"/> traversal reaches a method declaration, then the syntax
that is produced wraps a call to the original method, using the syntax generators in
<see cref="T:NETMetaCoder.CodeWrapTransformationOptions"/>.
</remarks>
</member>
<member name="T:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelope">
<inheritdoc cref="T:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelopeBase"/>
</member>
<member name="M:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelope.#ctor(Microsoft.CodeAnalysis.CSharp.Syntax.ClassDeclarationSyntax,System.UInt16)">
<summary>
Constructs an instance of <see cref="T:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelope"/> to hold an instance of
<see cref="T:Microsoft.CodeAnalysis.CSharp.Syntax.ClassDeclarationSyntax"/>, along with a sub tree of its descendant nodes..
</summary>
<param name="syntax">
The class declaration syntax.
</param>
<param name="nodeIndex">
A unique index for the syntax node, in order to identify it again in a later pass.
</param>
</member>
<member name="M:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelope.#ctor(Microsoft.CodeAnalysis.CSharp.Syntax.StructDeclarationSyntax,System.UInt16)">
<summary>
Constructs an instance of <see cref="T:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelope"/> to hold an instance of
<see cref="T:Microsoft.CodeAnalysis.CSharp.Syntax.StructDeclarationSyntax"/>.
</summary>
<param name="syntax">
The struct declaration syntax.
</param>
<param name="nodeIndex">
A unique index for the syntax node, in order to identify it again in a later pass.
</param>
<seealso cref="P:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelope.NodeIndex"/>
</member>
<member name="P:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelope.DeclarationSyntax">
<summary>
The declaration syntax of the class or struct that this <see cref="T:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelope"/> refers to.
</summary>
</member>
<member name="P:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelope.MethodSyntaxEnvelopes">
<summary>
The method syntax nodes that are direct children of the class or struct syntax node, held by an instance of
<see cref="T:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelope"/>.
</summary>
</member>
<member name="P:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelope.NodeIndex">
<inheritdoc cref="P:NETMetaCoder.SyntaxEnvelope.IIndexedSyntaxEnvelope.NodeIndex"/>
</member>
<member name="M:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelope.AddMethodSyntax(Microsoft.CodeAnalysis.CSharp.Syntax.MethodDeclarationSyntax,System.UInt16,System.Collections.Immutable.ImmutableHashSet{System.String},Microsoft.CodeAnalysis.CSharp.Syntax.AttributeSyntax)">
<summary>
Adds a method declaration syntax node to the envelope.
</summary>
<param name="syntax"></param>
<param name="nodeIndex"></param>
<param name="attributeNamesFound">
The names of the attributes found on the method declaration.
</param>
<param name="methodObsoletion">
The syntax node for the <see cref="T:System.ObsoleteAttribute"/> found on the method declaration, if any.
</param>
<returns>
It returns a new envelope, which is a child of the envelope instance in the context of which,
<see cref="M:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelope.AddMethodSyntax(Microsoft.CodeAnalysis.CSharp.Syntax.MethodDeclarationSyntax,System.UInt16,System.Collections.Immutable.ImmutableHashSet{System.String},Microsoft.CodeAnalysis.CSharp.Syntax.AttributeSyntax)"/> was called (ie, it returns the next level in the tree of syntax nodes).
</returns>
<seealso cref="T:NETMetaCoder.SyntaxEnvelope.MethodSyntaxEnvelope"/>
</member>
<member name="T:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelopeBase">
<summary>
A type that holds the syntax elements found in a class or struct declaration.
</summary>
<seealso cref="T:NETMetaCoder.SyntaxEnvelope.SyntaxEnvelope"/>
</member>
<member name="P:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelopeBase.ClassDeclarationSyntax">
<summary>
The <see cref="P:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelopeBase.ClassDeclarationSyntax"/> held inside the <see cref="T:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelope"/> instance.
</summary>
</member>
<member name="P:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelopeBase.StructDeclarationSyntax">
<summary>
The <see cref="P:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelopeBase.StructDeclarationSyntax"/> held inside the <see cref="T:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelope"/>
instance.
</summary>
</member>
<member name="P:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelopeBase.IsClassDeclarationSyntax">
<summary>
Returns <c>true</c> if this <see cref="T:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelope"/> instance holds a
<see cref="P:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelopeBase.ClassDeclarationSyntax"/> and <c>false</c> otherwise.
</summary>
</member>
<member name="P:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelopeBase.ClassOrStructSyntaxEnvelopes">
<summary>
The class and struct syntax nodes that are direct children of the class or struct syntax node, held by an
instance of <see cref="T:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelope"/>.
</summary>
</member>
<member name="M:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelopeBase.AddClassSyntax(Microsoft.CodeAnalysis.CSharp.Syntax.ClassDeclarationSyntax,System.UInt16)">
<summary>
Adds a class declaration syntax node to the envelope.
</summary>
<param name="syntax"></param>
<param name="nodeIndex"></param>
<returns>
It returns a new envelope, which is a child of the envelope instance in the context of which,
<see cref="M:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelopeBase.AddClassSyntax(Microsoft.CodeAnalysis.CSharp.Syntax.ClassDeclarationSyntax,System.UInt16)"/> was called (ie, it returns the next level in the tree of syntax nodes).
</returns>
</member>
<member name="M:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelopeBase.AddStructSyntax(Microsoft.CodeAnalysis.CSharp.Syntax.StructDeclarationSyntax,System.UInt16)">
<summary>
Adds a struct declaration syntax node to the envelope.
</summary>
<param name="syntax"></param>
<param name="nodeIndex"></param>
<returns>
It returns a new envelope, which is a child of the envelope instance in the context of which,
<see cref="M:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelopeBase.AddStructSyntax(Microsoft.CodeAnalysis.CSharp.Syntax.StructDeclarationSyntax,System.UInt16)"/> was called (ie, it returns the next level in the tree of syntax nodes).
</returns>
</member>
<member name="M:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelopeBase.Prune">
<summary>
Prunes the syntax node tree rooted at an instance of <see cref="T:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelope"/> from empty
children envelopes.
</summary>
</member>
<member name="T:NETMetaCoder.SyntaxEnvelope.IIndexedSyntaxEnvelope">
<summary>
An interface to denote that a syntax envelope also has an index property.
</summary>
<seealso cref="T:NETMetaCoder.SyntaxEnvelope.SyntaxEnvelope"/>
<seealso cref="T:NETMetaCoder.SyntaxEnvelope.NamespaceSyntaxEnvelope"/>
<seealso cref="T:NETMetaCoder.SyntaxEnvelope.ClassOrStructSyntaxEnvelope"/>
<seealso cref="T:NETMetaCoder.SyntaxEnvelope.MethodSyntaxEnvelope"/>
</member>
<member name="P:NETMetaCoder.SyntaxEnvelope.IIndexedSyntaxEnvelope.NodeIndex">
<summary>
An index to be used when scanning a compilation unit, in order to build a tree of the unit's structure.
This index gives an identity to a specific syntax node within the built tree.
</summary>
<seealso cref="T:NETMetaCoder.SyntaxEnvelope.SyntaxEnvelope"/>
</member>
<member name="T:NETMetaCoder.SyntaxEnvelope.MethodSyntaxEnvelope">
<summary>
A type that holds the syntax elements found in a method declaration.
</summary>
<seealso cref="T:NETMetaCoder.SyntaxEnvelope.SyntaxEnvelope"/>
</member>
<member name="M:NETMetaCoder.SyntaxEnvelope.MethodSyntaxEnvelope.#ctor(Microsoft.CodeAnalysis.CSharp.Syntax.MethodDeclarationSyntax,System.UInt16,System.Collections.Immutable.ImmutableHashSet{System.String},Microsoft.CodeAnalysis.CSharp.Syntax.AttributeSyntax)">
<summary>
Constructs an instance of <see cref="T:NETMetaCoder.SyntaxEnvelope.MethodSyntaxEnvelope"/> to hold an instance of
<see cref="P:NETMetaCoder.SyntaxEnvelope.MethodSyntaxEnvelope.MethodDeclarationSyntax"/>.
</summary>
<param name="syntax">
The class declaration syntax.
</param>
<param name="nodeIndex">
A unique index for the syntax node, in order to identify it again in a later pass.
</param>
<param name="attributeNamesFound">
The names of the attributes found on the method declaration.
</param>
<param name="methodObsoletion">
The syntax node for the <see cref="T:System.ObsoleteAttribute"/> found on the method declaration, if any.
</param>
</member>
<member name="P:NETMetaCoder.SyntaxEnvelope.MethodSyntaxEnvelope.MethodDeclarationSyntax">
<summary>
The <see cref="P:NETMetaCoder.SyntaxEnvelope.MethodSyntaxEnvelope.MethodDeclarationSyntax"/> held inside the <see cref="T:NETMetaCoder.SyntaxEnvelope.MethodSyntaxEnvelope"/> instance.
</summary>
</member>
<member name="P:NETMetaCoder.SyntaxEnvelope.MethodSyntaxEnvelope.AttributeNamesFound">
<summary>
The names of the attributes found on the method declaration.
</summary>
</member>
<member name="P:NETMetaCoder.SyntaxEnvelope.MethodSyntaxEnvelope.MethodObsoletion">
<summary>
The syntax node for the <see cref="T:System.ObsoleteAttribute"/> found on the method declaration, if any.
</summary>
</member>
<member name="P:NETMetaCoder.SyntaxEnvelope.MethodSyntaxEnvelope.NodeIndex">
<inheritdoc cref="P:NETMetaCoder.SyntaxEnvelope.IIndexedSyntaxEnvelope.NodeIndex"/>
</member>
<member name="T:NETMetaCoder.SyntaxEnvelope.NamespaceSyntaxEnvelope">
<inheritdoc cref="T:NETMetaCoder.SyntaxEnvelope.NamespaceSyntaxEnvelopeBase"/>
</member>
<member name="M:NETMetaCoder.SyntaxEnvelope.NamespaceSyntaxEnvelope.#ctor(Microsoft.CodeAnalysis.CSharp.Syntax.NamespaceDeclarationSyntax,System.UInt16)">
<summary>
Constructs an instance of <see cref="T:NETMetaCoder.SyntaxEnvelope.NamespaceSyntaxEnvelope"/> to hold an instance of
<see cref="T:Microsoft.CodeAnalysis.CSharp.Syntax.NamespaceDeclarationSyntax"/>, along with a sub tree of its descendant nodes.
</summary>
<param name="syntax">
The namespace declaration syntax.
</param>
<param name="nodeIndex">
A unique index for the syntax node, in order to identify it again in a later pass.
</param>
</member>
<member name="T:NETMetaCoder.SyntaxEnvelope.NamespaceSyntaxEnvelopeBase">
<summary>
A type that holds the syntax elements found in a namespace declaration.
</summary>
<seealso cref="T:NETMetaCoder.SyntaxEnvelope.SyntaxEnvelope"/>
</member>
<member name="P:NETMetaCoder.SyntaxEnvelope.NamespaceSyntaxEnvelopeBase.NamespaceDeclarationSyntax">
<summary>
The <see cref="P:NETMetaCoder.SyntaxEnvelope.NamespaceSyntaxEnvelopeBase.NamespaceDeclarationSyntax"/> held inside the <see cref="T:NETMetaCoder.SyntaxEnvelope.NamespaceSyntaxEnvelope"/> instance.
</summary>
</member>
<member name="P:NETMetaCoder.SyntaxEnvelope.NamespaceSyntaxEnvelopeBase.NamespaceSyntaxEnvelopes">
<summary>
The namespace syntax nodes that are direct children of the namespace syntax node, held by an instance of
<see cref="T:NETMetaCoder.SyntaxEnvelope.NamespaceSyntaxEnvelope"/>.
</summary>
</member>
<member name="P:NETMetaCoder.SyntaxEnvelope.NamespaceSyntaxEnvelopeBase.NodeIndex">
<inheritdoc cref="P:NETMetaCoder.SyntaxEnvelope.IIndexedSyntaxEnvelope.NodeIndex"/>
</member>
<member name="M:NETMetaCoder.SyntaxEnvelope.NamespaceSyntaxEnvelopeBase.AddNamespaceSyntax(Microsoft.CodeAnalysis.CSharp.Syntax.NamespaceDeclarationSyntax,System.UInt16)">
<summary>
Adds a namespace declaration syntax node to the envelope.
</summary>
<param name="syntax"></param>
<param name="nodeIndex"></param>
<returns>
It returns a new envelope, which is a child of the envelope instance in the context of which,
<see cref="M:NETMetaCoder.SyntaxEnvelope.NamespaceSyntaxEnvelopeBase.AddNamespaceSyntax(Microsoft.CodeAnalysis.CSharp.Syntax.NamespaceDeclarationSyntax,System.UInt16)"/> was called (ie, it returns the next level in the tree of syntax nodes).
</returns>
</member>
<member name="M:NETMetaCoder.SyntaxEnvelope.NamespaceSyntaxEnvelopeBase.Prune">
<summary>
Prunes the syntax node tree rooted at an instance of <see cref="T:NETMetaCoder.SyntaxEnvelope.NamespaceSyntaxEnvelope"/> from empty
children envelopes.
</summary>
</member>
<member name="T:NETMetaCoder.SyntaxEnvelope.SyntaxEnvelope">
<summary>
A type that holds a syntax tree for a compilation unit.
The syntax tree serves to filter out all but what is important for this library to work on.
Namely, this library needs only an hierarchy of namespaces, classes, structs and methods.
</summary>
</member>
<member name="P:NETMetaCoder.SyntaxEnvelope.SyntaxEnvelope.Usings">
<summary>
The using declaration syntax nodes that are used in the compilation unit, held by an instance of
<see cref="T:NETMetaCoder.SyntaxEnvelope.SyntaxEnvelope"/>.
</summary>
</member>
<member name="P:NETMetaCoder.SyntaxEnvelope.SyntaxEnvelope.AttributeNamesFound">
<summary>
A set of attribute names found, on method declarations, throughout the compilation unit's syntax tree.
</summary>
</member>
<member name="P:NETMetaCoder.SyntaxEnvelope.SyntaxEnvelope.HasSyntaxToRender">
<summary>
Returns true if there are any namespace, class or struct declarations in a compilation unit.
</summary>
</member>
<member name="M:NETMetaCoder.SyntaxEnvelope.SyntaxEnvelope.AddUsingDirectiveSyntax(Microsoft.CodeAnalysis.CSharp.Syntax.UsingDirectiveSyntax)">
<summary>
Adds a using declaration syntax node to the envelope.
</summary>
<param name="syntax"></param>
</member>
<member name="M:NETMetaCoder.SyntaxEnvelope.SyntaxEnvelope.AddAttributeNameFound(System.String)">
<summary>
Adds a found attribute's name to the envelope.
</summary>
</member>
<member name="M:NETMetaCoder.SyntaxEnvelope.SyntaxEnvelope.GatherNodeIndices">
<summary>
Gathers the syntax node indices of the whole tree so that the returned <see cref="T:System.Collections.Generic.HashSet`1"/> can serve as
an index of seen syntax nodes.
This is index is used by subsequent compilation unit passes, to filter out unwanted syntax nodes.
</summary>
<returns></returns>
</member>
<member name="M:NETMetaCoder.SyntaxEnvelope.SyntaxEnvelope.Prune">
<summary>
Prunes the syntax node tree rooted at an instance of <see cref="T:NETMetaCoder.SyntaxEnvelope.SyntaxEnvelope"/> from empty children
envelopes.
</summary>
</member>
<member name="T:NETMetaCoder.SyntaxRewriter">
<summary>
This type is responsible for rewriting a compilation unit's syntax.
</summary>
</member>
<member name="M:NETMetaCoder.SyntaxRewriter.RewriteSyntaxTree(Microsoft.CodeAnalysis.SyntaxTree,System.Collections.Generic.IEnumerable{System.String},NETMetaCoder.SyntaxEnvelope.SyntaxEnvelope)">
<summary>
Constructs a new <see cref="T:NETMetaCoder.SyntaxRewriter"/> instance.
</summary>
<param name="tree"></param>
<param name="attributeNames"></param>
<param name="syntaxEnvelope"></param>
<returns></returns>
</member>
<member name="T:NETMetaCoder.SyntaxRewriteResult">
<summary>
Represents the result of an invocation of <see cref="T:NETMetaCoder.SyntaxRewriter"/>.
</summary>
</member>
<member name="P:NETMetaCoder.SyntaxRewriteResult.SyntaxTree">
<summary>
The potentially rewritten syntax tree of the processed compilation unit.
</summary>
</member>
<member name="P:NETMetaCoder.SyntaxRewriteResult.HasChanges">
<summary>
If true, then a rewrite occured for the processed compilation unit.
</summary>
</member>
<member name="T:NETMetaCoder.SyntaxScanner">
<summary>
This type encapsulates the logic for building a <see cref="N:NETMetaCoder.SyntaxEnvelope"/>, by scanning the syntax tree of a
compilation unit.
</summary>
</member>
<member name="M:NETMetaCoder.SyntaxScanner.ScanSyntaxTree(Microsoft.CodeAnalysis.SyntaxTree,System.Collections.Generic.IEnumerable{System.String})">
<summary>
Constructs a new <see cref="T:NETMetaCoder.SyntaxScanner"/> instance.
</summary>
<param name="tree"></param>
<param name="attributeNames"></param>
<returns></returns>
</member>
</members>
</doc>