Skip to content

Commit e9aeec7

Browse files
KeRNeLithKeRNeLith
committed
Fix documentation generation warnings.
1 parent 6d682be commit e9aeec7

18 files changed

+228
-227
lines changed

‎docs/documentation/benchmarks.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ Here are those benchmarks:
77
- [Get/Set](benchmarks/get_set_benchmarks.md)
88
- [Multiple Get/Set](benchmarks/multiple_get_set_benchmarks.md)
99
- [Get/Set multiple objects](benchmarks/get_set_multiple_objects_benchmarks.md)
10-
- [Constructor](benchmarks/constructor_benchmarks.md)
10+
- [Constructor](benchmarks/default_constructor_benchmarks.md)
11+
- [Copy Constructor](benchmarks/copy_constructor_benchmarks.md)
1112
- [Get Attributes](benchmarks/attributes_benchmarks.md)

‎src/ImmediateReflection/Cache/AttributesCache.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ public bool IsDefined<TAttribute>(bool inherit)
5555
/// <param name="attributeType">Type of the attribute to search.</param>
5656
/// <param name="inherit">Indicates if inherited attributes should be taken into account.</param>
5757
/// <returns>True if an attribute matches requested type, otherwise false.</returns>
58-
/// <exception cref="ArgumentNullException">If the given <paramref name="attributeType"/> is null.</exception>
59-
/// <exception cref="ArgumentException">If the given <paramref name="attributeType"/> is not an <see cref="Attribute"/> type.</exception>
58+
/// <exception cref="T:System.ArgumentNullException">If the given <paramref name="attributeType"/> is null.</exception>
59+
/// <exception cref="T:System.ArgumentException">If the given <paramref name="attributeType"/> is not an <see cref="Attribute"/> type.</exception>
6060
[Pure]
6161
[ContractAnnotation("attributeType:null => halt")]
6262
#if SUPPORTS_AGGRESSIVE_INLINING
@@ -104,8 +104,8 @@ TAttribute FindAttribute(Attribute[] attributes)
104104
/// <param name="attributeType">Type of the attribute to search.</param>
105105
/// <param name="inherit">Indicates if inherited attributes should be taken into account.</param>
106106
/// <returns>The first attribute matching requested type, otherwise null.</returns>
107-
/// <exception cref="ArgumentNullException">If the given <paramref name="attributeType"/> is null.</exception>
108-
/// <exception cref="ArgumentException">If the given <paramref name="attributeType"/> is not an <see cref="Attribute"/> type.</exception>
107+
/// <exception cref="T:System.ArgumentNullException">If the given <paramref name="attributeType"/> is null.</exception>
108+
/// <exception cref="T:System.ArgumentException">If the given <paramref name="attributeType"/> is not an <see cref="Attribute"/> type.</exception>
109109
[Pure]
110110
[CanBeNull]
111111
[ContractAnnotation("attributeType:null => halt")]

‎src/ImmediateReflection/Delegates/DelegatesFactory.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -399,9 +399,9 @@ private static DynamicMethod CreateDynamicCopyConstructor([NotNull] string name,
399399
}
400400

401401
/// <summary>
402-
/// Gets the <see cref="Type"/> of the <paramref name="member"/> owner.
402+
/// Gets the <see cref="T:System.Type"/> of the <paramref name="member"/> owner.
403403
/// </summary>
404-
/// <exception cref="InvalidOperationException">If it's impossible to retrieve the owner <see cref="Type"/>.</exception>
404+
/// <exception cref="InvalidOperationException">If it's impossible to retrieve the owner <see cref="T:System.Type"/>.</exception>
405405
[Pure]
406406
[NotNull]
407407
[ContractAnnotation("member:null => halt")]

‎src/ImmediateReflection/Extensions/ImmediateAttributesExtensions.cs

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#if SUPPORTS_CACHING
1+
#if SUPPORTS_CACHING
22
using System;
33
using System.Collections.Generic;
44
using System.Reflection;
@@ -22,7 +22,7 @@ public static class ImmediateAttributesExtensions
2222
/// <param name="member">Member to get its custom attributes.</param>
2323
/// <param name="inherit">Indicates if inherited attributes should be taken into account.</param>
2424
/// <returns>True if an attribute matches requested type, otherwise false.</returns>
25-
/// <exception cref="ArgumentNullException">If the given <paramref name="member"/> is null.</exception>
25+
/// <exception cref="T:System.ArgumentNullException">If the given <paramref name="member"/> is null.</exception>
2626
[PublicAPI]
2727
[ContractAnnotation("member:null => halt")]
2828
#if SUPPORTS_AGGRESSIVE_INLINING
@@ -52,9 +52,9 @@ public static bool IsDefinedImmediateAttribute<TAttribute>(
5252
/// <param name="attributeType">Type of the attribute to search.</param>
5353
/// <param name="inherit">Indicates if inherited attributes should be taken into account.</param>
5454
/// <returns>True if an attribute matches requested type, otherwise false.</returns>
55-
/// <exception cref="ArgumentNullException">If the given <paramref name="member"/> is null.</exception>
56-
/// <exception cref="ArgumentNullException">If the given <paramref name="attributeType"/> is null.</exception>
57-
/// <exception cref="ArgumentException">If the given <paramref name="attributeType"/> is not an <see cref="Attribute"/> type.</exception>
55+
/// <exception cref="T:System.ArgumentNullException">If the given <paramref name="member"/> is null.</exception>
56+
/// <exception cref="T:System.ArgumentNullException">If the given <paramref name="attributeType"/> is null.</exception>
57+
/// <exception cref="T:System.ArgumentException">If the given <paramref name="attributeType"/> is not an <see cref="T:System.Attribute"/> type.</exception>
5858
[PublicAPI]
5959
[ContractAnnotation("member:null => halt;attributeType:null => halt")]
6060
#if SUPPORTS_AGGRESSIVE_INLINING
@@ -84,7 +84,7 @@ public static bool IsDefinedImmediateAttribute(
8484
/// <param name="member">Member to get its custom attributes.</param>
8585
/// <param name="inherit">Indicates if inherited attributes should be taken into account.</param>
8686
/// <returns>The first attribute matching requested type, otherwise null.</returns>
87-
/// <exception cref="ArgumentNullException">If the given <paramref name="member"/> is null.</exception>
87+
/// <exception cref="T:System.ArgumentNullException">If the given <paramref name="member"/> is null.</exception>
8888
[PublicAPI]
8989
[CanBeNull]
9090
[ContractAnnotation("member:null => halt")]
@@ -115,8 +115,8 @@ public static TAttribute GetImmediateAttribute<TAttribute>(
115115
/// <param name="attributeType">Type of the attribute to search.</param>
116116
/// <param name="inherit">Indicates if inherited attributes should be taken into account.</param>
117117
/// <returns>The first attribute matching requested type, otherwise null.</returns>
118-
/// <exception cref="ArgumentNullException">If the given <paramref name="member"/> or the <paramref name="attributeType"/> is null.</exception>
119-
/// <exception cref="ArgumentException">If the given <paramref name="attributeType"/> is not an <see cref="Attribute"/> type.</exception>
118+
/// <exception cref="T:System.ArgumentNullException">If the given <paramref name="member"/> or the <paramref name="attributeType"/> is null.</exception>
119+
/// <exception cref="T:System.ArgumentException">If the given <paramref name="attributeType"/> is not an <see cref="T:System.Attribute"/> type.</exception>
120120
[PublicAPI]
121121
[CanBeNull]
122122
[ContractAnnotation("member:null => halt;attributeType:null => halt")]
@@ -147,7 +147,7 @@ public static Attribute GetImmediateAttribute(
147147
/// <param name="member">Member to get its custom attributes.</param>
148148
/// <param name="inherit">Indicates if inherited attributes should be taken into account.</param>
149149
/// <returns>Attributes matching requested type.</returns>
150-
/// <exception cref="ArgumentNullException">If the given <paramref name="member"/> is null.</exception>
150+
/// <exception cref="T:System.ArgumentNullException">If the given <paramref name="member"/> is null.</exception>
151151
[PublicAPI]
152152
[NotNull, ItemNotNull]
153153
[ContractAnnotation("member:null => halt")]
@@ -178,7 +178,7 @@ public static IEnumerable<TAttribute> GetImmediateAttributes<TAttribute>(
178178
/// <param name="attributeType">Type of the attribute to search.</param>
179179
/// <param name="inherit">Indicates if inherited attributes should be taken into account.</param>
180180
/// <returns>Attributes matching requested type.</returns>
181-
/// <exception cref="ArgumentNullException">If the given <paramref name="member"/> is null.</exception>
181+
/// <exception cref="T:System.ArgumentNullException">If the given <paramref name="member"/> is null.</exception>
182182
[PublicAPI]
183183
[NotNull, ItemNotNull]
184184
[ContractAnnotation("member:null => halt;attributeType:null => halt")]
@@ -208,7 +208,7 @@ public static IEnumerable<Attribute> GetImmediateAttributes(
208208
/// <param name="member">Member to get its custom attributes.</param>
209209
/// <param name="inherit">Indicates if inherited attributes should be taken into account.</param>
210210
/// <returns>All attributes.</returns>
211-
/// <exception cref="ArgumentNullException">If the given <paramref name="member"/> is null.</exception>
211+
/// <exception cref="T:System.ArgumentNullException">If the given <paramref name="member"/> is null.</exception>
212212
[PublicAPI]
213213
[NotNull, ItemNotNull]
214214
[ContractAnnotation("member:null => halt")]

‎src/ImmediateReflection/Extensions/ImmediateMemberExtensions.cs

+21-21
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#if SUPPORTS_EXTENSIONS
1+
#if SUPPORTS_EXTENSIONS
22
using System;
33
using System.Collections.Generic;
44
using System.Reflection;
@@ -20,10 +20,10 @@ public static class ImmediateMemberExtensions
2020
/// <summary>
2121
/// Searches for the public <see cref="ImmediateField"/> corresponding to the given <paramref name="fieldName"/>.
2222
/// </summary>
23-
/// <param name="type">A <see cref="Type"/>.</param>
23+
/// <param name="type">A <see cref="T:System.Type"/>.</param>
2424
/// <param name="fieldName">Field name.</param>
2525
/// <returns>The corresponding <see cref="ImmediateField"/>, otherwise null.</returns>
26-
/// <exception cref="ArgumentNullException">If the given <paramref name="type"/> or <paramref name="fieldName"/> is null.</exception>
26+
/// <exception cref="T:System.ArgumentNullException">If the given <paramref name="type"/> or <paramref name="fieldName"/> is null.</exception>
2727
[PublicAPI]
2828
#if !SUPPORTS_CACHING
2929
[Pure]
@@ -41,11 +41,11 @@ public static ImmediateField GetImmediateField([NotNull] this Type type, [NotNul
4141
/// <summary>
4242
/// Searches for the <see cref="ImmediateField"/> corresponding to the given <paramref name="fieldName"/>.
4343
/// </summary>
44-
/// <param name="type">A <see cref="Type"/>.</param>
44+
/// <param name="type">A <see cref="T:System.Type"/>.</param>
4545
/// <param name="fieldName">Field name.</param>
4646
/// <param name="flags">Flags that must be taken into account to get members.</param>
4747
/// <returns>The corresponding <see cref="ImmediateField"/>, otherwise null.</returns>
48-
/// <exception cref="ArgumentNullException">If the given <paramref name="type"/> or <paramref name="fieldName"/> is null.</exception>
48+
/// <exception cref="T:System.ArgumentNullException">If the given <paramref name="type"/> or <paramref name="fieldName"/> is null.</exception>
4949
[PublicAPI]
5050
#if !SUPPORTS_CACHING
5151
[Pure]
@@ -61,11 +61,11 @@ public static ImmediateField GetImmediateField([NotNull] this Type type, [NotNul
6161
}
6262

6363
/// <summary>
64-
/// Gets all the public fields of this <see cref="Type"/>.
64+
/// Gets all the public fields of this <see cref="T:System.Type"/>.
6565
/// </summary>
66-
/// <param name="type">A <see cref="Type"/>.</param>
66+
/// <param name="type">A <see cref="T:System.Type"/>.</param>
6767
/// <returns>All <see cref="ImmediateField"/>.</returns>
68-
/// <exception cref="ArgumentNullException">If the given <paramref name="type"/> is null.</exception>
68+
/// <exception cref="T:System.ArgumentNullException">If the given <paramref name="type"/> is null.</exception>
6969
[PublicAPI]
7070
#if !SUPPORTS_CACHING
7171
[Pure]
@@ -81,12 +81,12 @@ public static IEnumerable<ImmediateField> GetImmediateFields([NotNull] this Type
8181
}
8282

8383
/// <summary>
84-
/// Gets all the fields of this <see cref="Type"/>.
84+
/// Gets all the fields of this <see cref="T:System.Type"/>.
8585
/// </summary>
86-
/// <param name="type">A <see cref="Type"/>.</param>
86+
/// <param name="type">A <see cref="T:System.Type"/>.</param>
8787
/// <param name="flags">Flags that must be taken into account to get members.</param>
8888
/// <returns>All <see cref="ImmediateField"/>.</returns>
89-
/// <exception cref="ArgumentNullException">If the given <paramref name="type"/> is null.</exception>
89+
/// <exception cref="T:System.ArgumentNullException">If the given <paramref name="type"/> is null.</exception>
9090
[PublicAPI]
9191
#if !SUPPORTS_CACHING
9292
[Pure]
@@ -108,10 +108,10 @@ public static IEnumerable<ImmediateField> GetImmediateFields([NotNull] this Type
108108
/// <summary>
109109
/// Searches for the public <see cref="ImmediateProperty"/> corresponding to the given <paramref name="propertyName"/>.
110110
/// </summary>
111-
/// <param name="type">A <see cref="Type"/>.</param>
111+
/// <param name="type">A <see cref="T:System.Type"/>.</param>
112112
/// <param name="propertyName">Property name.</param>
113113
/// <returns>The corresponding <see cref="ImmediateProperty"/>, otherwise null.</returns>
114-
/// <exception cref="ArgumentNullException">If the given <paramref name="type"/> or <paramref name="propertyName"/> is null.</exception>
114+
/// <exception cref="T:System.ArgumentNullException">If the given <paramref name="type"/> or <paramref name="propertyName"/> is null.</exception>
115115
[PublicAPI]
116116
#if !SUPPORTS_CACHING
117117
[Pure]
@@ -129,11 +129,11 @@ public static ImmediateProperty GetImmediateProperty([NotNull] this Type type, [
129129
/// <summary>
130130
/// Searches for the <see cref="ImmediateProperty"/> corresponding to the given <paramref name="propertyName"/>.
131131
/// </summary>
132-
/// <param name="type">A <see cref="Type"/>.</param>
132+
/// <param name="type">A <see cref="T:System.Type"/>.</param>
133133
/// <param name="propertyName">Property name.</param>
134134
/// <param name="flags">Flags that must be taken into account to get members.</param>
135135
/// <returns>The corresponding <see cref="ImmediateProperty"/>, otherwise null.</returns>
136-
/// <exception cref="ArgumentNullException">If the given <paramref name="type"/> or <paramref name="propertyName"/> is null.</exception>
136+
/// <exception cref="T:System.ArgumentNullException">If the given <paramref name="type"/> or <paramref name="propertyName"/> is null.</exception>
137137
[PublicAPI]
138138
#if !SUPPORTS_CACHING
139139
[Pure]
@@ -149,11 +149,11 @@ public static ImmediateProperty GetImmediateProperty([NotNull] this Type type, [
149149
}
150150

151151
/// <summary>
152-
/// Gets all the public properties of this <see cref="Type"/>.
152+
/// Gets all the public properties of this <see cref="T:System.Type"/>.
153153
/// </summary>
154-
/// <param name="type">A <see cref="Type"/>.</param>
154+
/// <param name="type">A <see cref="T:System.Type"/>.</param>
155155
/// <returns>All <see cref="ImmediateProperty"/>.</returns>
156-
/// <exception cref="ArgumentNullException">If the given <paramref name="type"/> is null.</exception>
156+
/// <exception cref="T:System.ArgumentNullException">If the given <paramref name="type"/> is null.</exception>
157157
[PublicAPI]
158158
#if !SUPPORTS_CACHING
159159
[Pure]
@@ -169,12 +169,12 @@ public static IEnumerable<ImmediateProperty> GetImmediateProperties([NotNull] th
169169
}
170170

171171
/// <summary>
172-
/// Gets all the properties of this <see cref="Type"/>.
172+
/// Gets all the properties of this <see cref="T:System.Type"/>.
173173
/// </summary>
174-
/// <param name="type">A <see cref="Type"/>.</param>
174+
/// <param name="type">A <see cref="T:System.Type"/>.</param>
175175
/// <param name="flags">Flags that must be taken into account to get members.</param>
176176
/// <returns>All <see cref="ImmediateProperty"/>.</returns>
177-
/// <exception cref="ArgumentNullException">If the given <paramref name="type"/> is null.</exception>
177+
/// <exception cref="T:System.ArgumentNullException">If the given <paramref name="type"/> is null.</exception>
178178
[PublicAPI]
179179
#if !SUPPORTS_CACHING
180180
[Pure]

‎src/ImmediateReflection/Extensions/ImmediateReflectionExtensions.cs

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
using System;
1+
using System;
22
#if SUPPORTS_AGGRESSIVE_INLINING
33
using System.Runtime.CompilerServices;
44
#endif
@@ -18,7 +18,7 @@ public static class ImmediateReflectionExtensions
1818
/// <typeparam name="T">Object type.</typeparam>
1919
/// <param name="obj">Object instance.</param>
2020
/// <returns>The corresponding <see cref="ImmediateType"/>.</returns>
21-
/// <exception cref="ArgumentNullException">If the given <paramref name="obj"/>is null.</exception>
21+
/// <exception cref="T:System.ArgumentNullException">If the given <paramref name="obj"/>is null.</exception>
2222
[PublicAPI]
2323
#if !SUPPORTS_CACHING
2424
[Pure]
@@ -43,11 +43,11 @@ [NotNull] T obj
4343

4444
#if SUPPORTS_EXTENSIONS
4545
/// <summary>
46-
/// Gets the <see cref="ImmediateType"/> corresponding to this <see cref="Type"/>.
46+
/// Gets the <see cref="ImmediateType"/> corresponding to this <see cref="T:System.Type"/>.
4747
/// </summary>
48-
/// <param name="type">A <see cref="Type"/>.</param>
48+
/// <param name="type">A <see cref="T:System.Type"/>.</param>
4949
/// <returns>The corresponding <see cref="ImmediateType"/>.</returns>
50-
/// <exception cref="ArgumentNullException">If the given <paramref name="type"/>is null.</exception>
50+
/// <exception cref="T:System.ArgumentNullException">If the given <paramref name="type"/>is null.</exception>
5151
[PublicAPI]
5252
#if !SUPPORTS_CACHING
5353
[Pure]

0 commit comments

Comments
 (0)