Fixing XML documentation comments - closes #112

bfren · Jan 1, 2022 · 5bd3209 · 5bd3209
1 parent 24b3025
commit 5bd3209
Show file tree

Hide file tree

Showing 10 changed files with 28 additions and 15 deletions.
diff --git a/src/Jeebs.Cryptography/Lockable.cs b/src/Jeebs.Cryptography/Lockable.cs
@@ -55,6 +55,9 @@ public abstract class Lockable
 	/// </summary>
 	public static readonly int KeyLength = 32;
 
+	/// <summary>
+	/// Create object
+	/// </summary>
 	protected Lockable() { }
 
 	/// <summary>Messages</summary>

diff --git a/src/Jeebs.Cryptography/Locked.cs b/src/Jeebs.Cryptography/Locked.cs
@@ -132,6 +132,9 @@ private byte[] HashKey(string key) =>
 /// </summary>
 public abstract class Locked
 {
+	/// <summary>
+	/// Create object
+	/// </summary>
 	protected Locked() { }
 
 	/// <summary>Messages</summary>

diff --git a/src/Jeebs.Random/Rnd/NumberF/NumberF.GetInt32.cs b/src/Jeebs.Random/Rnd/NumberF/NumberF.GetInt32.cs
@@ -10,7 +10,7 @@ public static partial class Rnd
 	public static partial class NumberF
 	{
 		/// <summary>
-		/// Returns a random integer between <see cref="0"/> and <see cref="int.MaxValue"/> inclusive
+		/// Returns a random integer between <see langword="0"/> and <see cref="int.MaxValue"/> inclusive
 		/// </summary>
 		/// <remarks>
 		/// Don't share code with <see cref="GetInt32(int, int)"/> for memory allocation reasons
@@ -19,7 +19,7 @@ public static int GetInt32() =>
 			GetInt32(0, int.MaxValue);
 
 		/// <summary>
-		/// Returns a random integer between <see cref="0"/> and <paramref name="max"/> inclusive
+		/// Returns a random integer between <see langword="0"/> and <paramref name="max"/> inclusive
 		/// </summary>
 		/// <remarks>
 		/// Don't share code with <see cref="GetInt32(int, int)"/> for memory allocation reasons

diff --git a/src/Jeebs.Random/Rnd/NumberF/NumberF.GetInt64.cs b/src/Jeebs.Random/Rnd/NumberF/NumberF.GetInt64.cs
@@ -10,7 +10,7 @@ public static partial class Rnd
 	public static partial class NumberF
 	{
 		/// <summary>
-		/// Returns a random integer between <see cref="0"/> and <see cref="long.MaxValue"/> inclusive
+		/// Returns a random integer between <see langword="0"/> and <see cref="long.MaxValue"/> inclusive
 		/// </summary>
 		/// <remarks>
 		/// Don't share code with <see cref="GetInt32(int, int)"/> for memory allocation reasons
@@ -19,7 +19,7 @@ public static long GetInt64() =>
 			GetInt64(0, long.MaxValue);
 
 		/// <summary>
-		/// Returns a random integer between <see cref="0"/> and <paramref name="max"/> inclusive
+		/// Returns a random integer between <see langword="0"/> and <paramref name="max"/> inclusive
 		/// </summary>
 		/// <remarks>
 		/// Don't share code with <see cref="GetInt32(int, int)"/> for memory allocation reasons

diff --git a/src/Jeebs.Random/Rnd/NumberF/NumberF.GetUInt32.cs b/src/Jeebs.Random/Rnd/NumberF/NumberF.GetUInt32.cs
@@ -10,7 +10,7 @@ public static partial class Rnd
 	public static partial class NumberF
 	{
 		/// <summary>
-		/// Returns a random integer between <see cref="0"/> and <see cref="uint.MaxValue"/> inclusive
+		/// Returns a random integer between <see langword="0"/> and <see cref="uint.MaxValue"/> inclusive
 		/// </summary>
 		/// <remarks>
 		/// Don't share code with <see cref="GetUInt64(ulong, ulong)"/> for memory allocation reasons
@@ -19,7 +19,7 @@ public static uint GetUInt32() =>
 			GetUInt32(0, uint.MaxValue);
 
 		/// <summary>
-		/// Returns a random integer between <see cref="0"/> and <see cref="uint.MaxValue"/> inclusive
+		/// Returns a random integer between <see langword="0"/> and <see cref="uint.MaxValue"/> inclusive
 		/// </summary>
 		/// <remarks>
 		/// Don't share code with <see cref="GetUInt64(ulong, ulong)"/> for memory allocation reasons

diff --git a/src/Jeebs.Random/Rnd/NumberF/NumberF.GetUInt64.cs b/src/Jeebs.Random/Rnd/NumberF/NumberF.GetUInt64.cs
@@ -10,7 +10,7 @@ public static partial class Rnd
 	public static partial class NumberF
 	{
 		/// <summary>
-		/// Returns a random integer between <see cref="0"/> and <see cref="ulong.MaxValue"/> inclusive
+		/// Returns a random integer between <see langword="0"/> and <see cref="ulong.MaxValue"/> inclusive
 		/// </summary>
 		/// <remarks>
 		/// Don't share code with <see cref="GetUInt32(uint, uint)"/> for memory allocation reasons
@@ -19,7 +19,7 @@ public static ulong GetUInt64() =>
 			GetUInt64(0, ulong.MaxValue);
 
 		/// <summary>
-		/// Returns a random integer between <see cref="0"/> and <paramref name="max"/> inclusive
+		/// Returns a random integer between <see langword="0"/> and <paramref name="max"/> inclusive
 		/// </summary>
 		/// <remarks>
 		/// Don't share code with <see cref="GetUInt32(uint, uint)"/> for memory allocation reasons

diff --git a/src/Jeebs.WordPress.Data/CustomFields/AttachmentCustomField.cs b/src/Jeebs.WordPress.Data/CustomFields/AttachmentCustomField.cs
@@ -20,9 +20,14 @@ public abstract class AttachmentCustomField : CustomField<AttachmentCustomField.
 	/// </summary>
 	protected IQueryPosts QueryPosts { get; private init; }
 
-	/// <inheritdoc/>
+	/// <inheritdoc cref="CustomField{T}.CustomField(string, T)"/>
 	protected AttachmentCustomField(string key) : this(new Query.Posts(), key) { }
 
+	/// <summary>
+	/// Create object from posts
+	/// </summary>
+	/// <param name="queryPosts">IQueryPosts</param>
+	/// <param name="key">Meta key (for post_meta table)</param>
 	protected AttachmentCustomField(IQueryPosts queryPosts, string key) : base(key, new Attachment()) =>
 		QueryPosts = queryPosts;
 

diff --git a/src/Jeebs.WordPress.Data/CustomFields/FileCustomField.cs b/src/Jeebs.WordPress.Data/CustomFields/FileCustomField.cs
@@ -8,10 +8,7 @@ namespace Jeebs.WordPress.Data;
 /// </summary>
 public abstract class FileCustomField : AttachmentCustomField
 {
-	/// <summary>
-	/// Create object with specified meta key
-	/// </summary>
-	/// <param name="key">Meta key (for post_meta table)</param>
+	/// <inheritdoc cref="CustomField{T}.CustomField(string, T)"/>
 	protected FileCustomField(string key) : base(key) { }
 
 	/// <inheritdoc/>

diff --git a/src/Jeebs.WordPress.Data/CustomFields/TermCustomField.cs b/src/Jeebs.WordPress.Data/CustomFields/TermCustomField.cs
@@ -19,9 +19,14 @@ public abstract class TermCustomField : CustomField<TermCustomField.Term>
 	/// </summary>
 	protected IQueryTerms QueryTerms { get; private init; }
 
-	/// <inheritdoc/>
+	/// <inheritdoc cref="CustomField{T}.CustomField(string, T)"/>
 	protected TermCustomField(string key) : this(new Query.Terms(), key) { }
 
+	/// <summary>
+	/// Create object from terms
+	/// </summary>
+	/// <param name="queryTerms">IQueryTerms</param>
+	/// <param name="key">Meta key (for post_meta table)</param>
 	protected TermCustomField(IQueryTerms queryTerms, string key) : base(key, new Term()) =>
 		QueryTerms = queryTerms;
 

diff --git a/src/Jeebs.WordPress.Data/CustomFields/TextCustomField.cs b/src/Jeebs.WordPress.Data/CustomFields/TextCustomField.cs
@@ -25,7 +25,7 @@ public override string ValueObj
 			ValueStr = value;
 	}
 
-	/// <inheritdoc/>
+	/// <inheritdoc cref="CustomField{T}.CustomField(string, T)"/>
 	protected TextCustomField(string key) : base(key, string.Empty) { }
 
 	/// <inheritdoc/>