update docs

diff --git a/vke/src/ShaderInfo.cs b/vke/src/ShaderInfo.cs
index 6e7a41ed8aa84484ba28534502ff3f14cce6467a..ba3c9c1e194ec030069f4e1954dce0ec420ca137 100644 (file)
--- a/vke/src/ShaderInfo.cs
+++ b/vke/src/ShaderInfo.cs
@@ -43,8 +43,9 @@ namespace vke {
                /// </summary>
                /// <param name="dev">vke Device</param>
                /// <param name="_stageFlags">Stage flags.</param>
-               /// <param name="_spirvPath">path to a compiled SpirV Shader on disk or as embedded ressource if path starts with '#' (ex; #Assembly.shader.vert.spv)</param>
-               /// or contains ':' (ex; Assembly:shader.vert.spv)</param>
+               /// <param name="_spirvPath">
+               /// Path to a compiled SpirV Shader on disk or as embedded ressource. See <see cref="Utils.GetStreamFromPath"/> for more information.
+               /// </param>
                /// <param name="specializationInfo">Specialization info</param>
                /// <param name="entryPoint">shader entry point, 'main' by default.</param>
                public ShaderInfo (Device dev, VkShaderStageFlags _stageFlags, string _spirvPath, SpecializationInfo specializationInfo = null, string entryPoint = "main"):

diff --git a/vke/src/Utils.cs b/vke/src/Utils.cs
index 86048bdf2f4d9dc048eefe53871ba7e6e32a3a86..80719626b33c47aff9e55b379a4f92d612f8942b 100644 (file)
--- a/vke/src/Utils.cs
+++ b/vke/src/Utils.cs
@@ -41,7 +41,7 @@ namespace Vulkan {
                /// <remarks>
                /// Embedded resource path start with `#`. The entry assembly is always searched first to be able
                /// to override resource defined in satellite assemblies.
-               /// To enforce assembly name selection, use `:` to split assembly and resource (ex; "Assembly:filename.spv"),
+               /// To enforce assembly name selection, use `:` to split assembly and resource (ex; "Assembly:LogicalName"),
                /// else assembly names will be determined with the first, or the two firsts names in the path string.
                /// (ex: AssemblyName.filename.ext then Assembly.Name.filename.ext)
                /// </remarks>

diff --git a/vke/src/base/CommandPool.cs b/vke/src/base/CommandPool.cs
index 3929163aaf4b3108c41f47766540e251fdf7012a..a77d800ce0d2e5cd11e1d559f4cf025ab7262d9c 100644 (file)
--- a/vke/src/base/CommandPool.cs
+++ b/vke/src/base/CommandPool.cs
@@ -10,6 +10,9 @@ namespace vke {
        /// <summary>
        /// Command pools are opaque objects that command buffer memory is allocated from, and which allow the implementation
        /// to amortize the cost of resource creation across multiple command buffers.
+       /// <para>
+       /// See <see href="https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/VkCommandPool.html"/> for more information.
+       /// </para>
        /// </summary>
        public sealed class CommandPool : Activable {
         public readonly uint QFamIndex;
@@ -22,17 +25,19 @@ namespace vke {
                /// </summary>
                /// <param name="device">Vulkan Device.</param>
                /// <param name="qFamIdx">Queue family index.</param>
+               /// <param name="flags">Command pool <see cref="VkCommandPoolCreateFlags">creation flags</see>.</param>
                public CommandPool (Device device, uint qFamIdx, VkCommandPoolCreateFlags flags = 0) : base(device)
-        {            
+        {
             QFamIndex = qFamIdx;
                        Flags = flags;
 
                        Activate ();
         }
                /// <summary>
-               /// Initializes a new instance of the [[CommandPool]]"/> class.
+               /// Initializes a new instance of the <see cref="CommandPool"/>" class.
                /// </summary>
-               /// <param name="queue">Device Queue of the queue family to create the pool for.</param>
+               /// <param name="queue">Device <see cref="Queue"/> of the queue family to create the pool for.</param>
+               /// <param name="flags">Command pool <see cref="VkCommandPoolCreateFlags">creation flags</see>.</param>
                public CommandPool (Queue queue, VkCommandPoolCreateFlags flags = 0) : this(queue.dev, queue.qFamIndex, flags) {}
                #endregion
 
@@ -40,7 +45,7 @@ namespace vke {
                                        => new VkDebugUtilsObjectNameInfoEXT (VkObjectType.CommandPool, handle.Handle);
 
                public override void Activate () {
-                       if (state != ActivableState.Activated) {            
+                       if (state != ActivableState.Activated) {
                    VkCommandPoolCreateInfo infos = VkCommandPoolCreateInfo.New();
                infos.queueFamilyIndex = QFamIndex;
                                infos.flags = Flags;
@@ -95,14 +100,14 @@ namespace vke {
                        Utils.CheckResult (vkAllocateCommandBuffers (Dev.VkDev, ref infos, buffs.Pin()));
                        buffs.Unpin ();
                        PrimaryCommandBuffer[] cmds = new PrimaryCommandBuffer[count];
-                       for (int i = 0; i < count; i++) 
+                       for (int i = 0; i < count; i++)
                                cmds[i] = new PrimaryCommandBuffer (Dev.VkDev, this, buffs[i]);
 
                        return cmds;
                }
                /// <summary>
                /// Resetting a command pool recycles all of the resources from all of the command buffers allocated from the command
-               /// pool back to the command pool. All command buffers that have been allocated from the command pool are put in the initial state. 
+               /// pool back to the command pool. All command buffers that have been allocated from the command pool are put in the initial state.
                /// Any primary command buffer allocated from another VkCommandPool that is in the recording or executable state and has a secondary
                /// command buffer allocated from commandPool recorded into it, becomes invalid.
                /// </summary>