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
|
// Copyright (c) Microsoft Corporation. All rights reserved.
//
//using System;
using System.Compiler;
using System.Xml.XPath;
namespace Microsoft.Ddue.Tools.Reflection {
// exposes all apis, including internal apis, for which documentation is written
// this includes all members except for property and event accessors (e.g. get_ methods) and delegate members (e.g. Invoke).
// enumeration members are included
public class AllDocumentedFilter : ApiFilter {
public AllDocumentedFilter() : base() { }
public AllDocumentedFilter(XPathNavigator configuration) : base(configuration) { }
public override bool IsExposedMember(Member member) {
// member of delegates are not exposed
TypeNode type = member.DeclaringType;
if (type.NodeType == NodeType.DelegateNode) return (false);
// accessor methods for properties and events are not exposed
if (member.IsSpecialName && (member.NodeType == NodeType.Method)) {
string name = member.Name.Name;
if (NameContains(name, "get_")) return (false);
if (NameContains(name, "set_")) return (false);
if (NameContains(name, "add_")) return (false);
if (NameContains(name, "remove_")) return (false);
if (NameContains(name, "raise_")) return (false);
}
// the value field of enumerations is not exposed
if (member.IsSpecialName && (type.NodeType == NodeType.EnumNode) && (member.NodeType == NodeType.Field)) {
string name = member.Name.Name;
if (name == "value__") return (false);
}
// members marked as compiler-generated are not exposed
if (ListContainsAttribute(member.Attributes, "System.Runtime.CompilerServices.CompilerGeneratedAttribute")) {
return (false);
}
// okay, passed all tests, so member is exposed
return (base.IsExposedMember(member));
}
// all namespace and all types are exposed
/** <summary>Check the given type and all parent types for compiler attributes.
* If none are found look for any filters to determine if it is exposed.</summary> */
public override bool IsExposedType(TypeNode type) {
// don't include compiler-generated types
// check this and all parents for compiler attributes
TypeNode curType = type; //cursor
while (curType != null)
{
if (ListContainsAttribute(curType.Attributes, "System.Runtime.CompilerServices.CompilerGeneratedAttribute"))
return false;
curType = curType.DeclaringType; //check the next parent
}
//continue on with checking if the type is exposed
return base.IsExposedType(type);
}
private static bool ListContainsAttribute(AttributeList attributes, string name) {
for (int i = 0; i < attributes.Count; i++) {
if (attributes[i].Type.FullName == name) return (true);
}
return (false);
}
private static bool NameContains(string name, string substring) {
return (name.Contains(substring));
}
}
}
|
