[avro] branch master updated: AVRO-3342 updated to standard documentation styling (#1492)

[mg...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

mgrigorov pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/avro.git


The following commit(s) were added to refs/heads/master by this push:
     new 8bae4d8  AVRO-3342 updated to standard documentation styling (#1492)
8bae4d8 is described below

commit 8bae4d83674dfd7b214c75bb920ecf1698f0919e
Author: Kyle Schoonover <ky...@minmaxcorp.com>
AuthorDate: Tue Feb 1 03:13:48 2022 -0800

    AVRO-3342 updated to standard documentation styling (#1492)
    
    Co-authored-by: Kyle T. Schoonover <Ky...@nordstrom.com>
---
 lang/csharp/src/apache/main/CodeGen/CodeGenUtil.cs | 39 +++++++++++++++-------
 1 file changed, 27 insertions(+), 12 deletions(-)

diff --git a/lang/csharp/src/apache/main/CodeGen/CodeGenUtil.cs b/lang/csharp/src/apache/main/CodeGen/CodeGenUtil.cs
index 0b3c177..0ed10c1 100644
--- a/lang/csharp/src/apache/main/CodeGen/CodeGenUtil.cs
+++ b/lang/csharp/src/apache/main/CodeGen/CodeGenUtil.cs
@@ -22,38 +22,53 @@ using System.CodeDom;
 namespace Avro
 {
     /// <summary>
-    /// A singleton class containing data used by codegen
+    /// A singleton class containing data used by codegen.
     /// </summary>
     public sealed class CodeGenUtil
     {
         /// <summary>
-        /// Singleton instance of this class.
+        /// Gets singleton instance of this class.
         /// </summary>
+        /// <value>
+        /// The instance.
+        /// </value>
         public static CodeGenUtil Instance { get; } = new CodeGenUtil();
 
         /// <summary>
-        /// Namespaces to import in generated code.
+        /// Gets namespaces to import in generated code.
         /// </summary>
+        /// <value>
+        /// The namespace imports.
+        /// </value>
         public CodeNamespaceImport[] NamespaceImports { get; private set; }
 
         /// <summary>
-        /// Comment included at the top of each generated code file.
+        /// Gets comment included at the top of each generated code file.
         /// </summary>
+        /// <value>
+        /// The file comment.
+        /// </value>
         public CodeCommentStatement FileComment { get; private set; }
 
         /// <summary>
-        /// Reserved keywords in the C# language.
+        /// Gets reserved keywords in the C# language.
         /// </summary>
+        /// <value>
+        /// The reserved keywords.
+        /// </value>
         public HashSet<string> ReservedKeywords { get; private set; }
 
         private const char At = '@';
         private const char Dot = '.';
 
         /// <summary>
-        /// Fully-qualified name of a <see cref="Object"/> type.
+        /// Fully-qualified name of a <see cref="Object" /> type.
         /// </summary>
         public const string Object = "System.Object";
 
+        /// <summary>
+        /// Prevents a default instance of the <see cref="CodeGenUtil"/> class from being created.
+        /// </summary>
         private CodeGenUtil()
         {
             NamespaceImports = new CodeNamespaceImport[] {
@@ -85,10 +100,10 @@ namespace Avro
         }
 
         /// <summary>
-        /// Append @ to all reserved keywords that appear on the given name
+        /// Append @ to all reserved keywords that appear on the given name.
         /// </summary>
-        /// <param name="name"></param>
-        /// <returns></returns>
+        /// <param name="name">The name.</param>
+        /// <returns>updated string.</returns>
         public string Mangle(string name)
         {
             var builder = new StringBuilder();
@@ -105,10 +120,10 @@ namespace Avro
         }
 
         /// <summary>
-        /// Remove all the @
+        /// Remove all the @.
         /// </summary>
-        /// <param name="name"></param>
-        /// <returns></returns>
+        /// <param name="name">The name.</param>
+        /// <returns>updated string.</returns>
         public string UnMangle(string name)
         {
             var builder = new StringBuilder(name.Length);