From: Shawdooow <banhammer1915@gmail.com>
Date: Sat, 20 Nov 2021 23:44:13 +0000 (-0500)
Subject: update docs
X-Git-Tag: v0.2.4-beta~13^2~3
X-Git-Url: https://git.osiis.dedyn.io/?a=commitdiff_plain;h=795e206dbaebdec97ca14227b10bf5edd87fdf1d;p=jp%2Fvke.net.git

update docs
---

diff --git a/vke/src/ShaderInfo.cs b/vke/src/ShaderInfo.cs
index 57f3974..7cc498b 100644
--- a/vke/src/ShaderInfo.cs
+++ b/vke/src/ShaderInfo.cs
@@ -43,7 +43,7 @@ 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 '#'</param>
+		/// <param name="_spirvPath">path to a compiled SpirV Shader on disk or as embedded ressource if path contains ':' (ex; Assembly:shader.vert.spv)</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 e82fc39..0a1ef6c 100644
--- a/vke/src/Utils.cs
+++ b/vke/src/Utils.cs
@@ -37,10 +37,10 @@ namespace Vulkan {
 		}
 		/// <summary>
 		/// Return a file or embedded resource stream.
-		/// Use : to split assembly and resource (ex; Assembly:shader.vert.spv)
+		/// Use ':' to split assembly and resource (ex; "Assembly:shader.vert.spv")
 		/// </summary>
 		/// <returns>The stream from path.</returns>
-		/// <param name="path">The file or stream path. Embedded resource path starts with '#'.</param>
+		/// <param name="path">The file or stream path. Embedded resource path contains ':'.</param>
 		public static Stream GetStreamFromPath (string path) {
 			if (path.Contains(":", StringComparison.Ordinal)) {
 				Stream stream = null;