Misc. Updates (#319)

* Updated doc comments
* Placed KLS visualizers into the proper namespace
* CHanged visibility of many types to internal that are not intended for external use.

Author: smaillet

src/Interop/Ubiquity.NET.Llvm.Interop/ArchitectureExtensions.cs

@@ -22,8 +22,9 @@ Architecture.Arm or
                 Architecture.Wasm => LibLLVMCodeGenTarget.CodeGenTarget_WebAssembly,
                 Architecture.LoongArch64 => LibLLVMCodeGenTarget.CodeGenTarget_LoongArch,
                 Architecture.Ppc64le => LibLLVMCodeGenTarget.CodeGenTarget_PowerPC,
+
 #if NET9_0_OR_GREATER
-                Architecture.RiscV64 => LibLLVMCodeGenTarget.CodeGenTarget_RISCV, // 64 vs 32 bit distinction is a CPU/Feature of the target
+                Architecture.RiscV64 => LibLLVMCodeGenTarget.CodeGenTarget_RISCV, // 64bit is the only form supported by .NET
 #endif
                 Architecture.S390x => LibLLVMCodeGenTarget.CodeGenTarget_SystemZ,
                 _ => throw new NotSupportedException( "Native code gen target is unknown" )

src/Samples/Kaleidoscope/Kaleidoscope.Grammar/DynamicRuntimeState.cs

@@ -22,12 +22,14 @@ namespace Kaleidoscope.Grammar
     /// <para>
     /// This provides storage and support methods for the runtime global state.
     /// The state includes:
-    /// * The language level to use for parsing
-    /// * The current set of operators, including any user defined operators so the
+    /// <list type="bullet">
+    /// <item>The language level to use for parsing</item>
+    /// <item>The current set of operators, including any user defined operators so the
     ///   parser knows how to resolve complex expressions with user defined operators
-    ///   and precedence.
-    /// * The current set of external declarations
-    /// * The current set of defined functions
+    ///   and precedence.</item>
+    /// <item>The current set of external declarations</item>
+    /// <item>The current set of defined functions</item>
+    /// </list>
     /// </para>
     /// </remarks>
     public class DynamicRuntimeState

src/Samples/Kaleidoscope/Kaleidoscope.Grammar/OperatorInfo.cs

@@ -6,7 +6,7 @@
 
 namespace Kaleidoscope.Grammar
 {
-    public enum OperatorKind
+    internal enum OperatorKind
     {
         None,
         InfixLeftAssociative,

src/Samples/Kaleidoscope/Kaleidoscope.Grammar/Visualizers/AstGraphGenerator.cs

@@ -3,13 +3,15 @@
 
 using System.Collections.Generic;
 
+using Kaleidoscope.Grammar.AST;
+
 using OpenSoftware.DgmlTools.Model;
 
 using Ubiquity.NET.Runtime.Utils;
 
-namespace Kaleidoscope.Grammar.AST
+namespace Kaleidoscope.Grammar.Visualizers
 {
-    public class AstGraphGenerator
+    internal class AstGraphGenerator
         : KaleidoscopeAstVisitorBase<object>
     {
         public AstGraphGenerator( )

src/Samples/Kaleidoscope/Kaleidoscope.Grammar/Visualizers/BlockDiagGenerator.cs

@@ -7,7 +7,7 @@
 
 using OpenSoftware.DgmlTools.Model;
 
-namespace Kaleidoscope.Grammar
+namespace Kaleidoscope.Grammar.Visualizers
 {
     /// <summary>Extension class to generate a blockdiag file from a DGML <see cref="DirectedGraph"/></summary>
     /// <remarks>
@@ -22,7 +22,7 @@ namespace Kaleidoscope.Grammar
     /// </para>
     /// </remarks>
     /// <seealso href="http://blockdiag.com"/>
-    public static class BlockDiagGenerator
+    internal static class BlockDiagGenerator
     {
         public static void WriteAsBlockDiag( this DirectedGraph graph, TextWriter writer )
         {

src/Samples/Kaleidoscope/Kaleidoscope.Grammar/Visualizers/DgmlGenerator.cs

@@ -14,7 +14,7 @@
 
 using static Kaleidoscope.Grammar.ANTLR.KaleidoscopeParser;
 
-namespace Kaleidoscope.Grammar
+namespace Kaleidoscope.Grammar.Visualizers
 {
     /// <summary>Parse tree listener to generate a DGML Graph of the parsed syntax</summary>
     /// <remarks>

src/Samples/Kaleidoscope/Kaleidoscope.Grammar/Visualizers/XDocumentListener.cs

@@ -11,7 +11,7 @@
 
 using Ubiquity.NET.ANTLR.Utils;
 
-namespace Kaleidoscope.Grammar
+namespace Kaleidoscope.Grammar.Visualizers
 {
     /// <summary>Parse listener that, when used with <see cref="ParseTreeWalker"/> generates an XML representation of the parse tree</summary>
     internal class XDocumentListener

src/Ubiquity.NET.InteropHelpers/ExecutionEncodingStringMarshaller.cs

@@ -31,7 +31,7 @@ public static unsafe class ExecutionEncodingStringMarshaller
         ///
         /// <note type="note">Even as well documented and well thought out as LLVM is, it remains silent on this point.
         /// Spelunking the build system generated for LLVM itself by CMake there is NOTHING to set either the source or
-        /// execution encodings for Windows, MSVC or any other tool-set that I can see so they seem to be left at defaults.
+        /// execution encoding for Windows, MSVC or any other tool-set that I can see so they seem to be left at defaults.
         /// (LLVM is just an example as it was where this library began, but it is not limited to that.)
         /// </note>
         ///