From 88562f4dc6baba647fe634b4804ec285c1bfd857 Mon Sep 17 00:00:00 2001
From: Joshua Goins <josh@redstrate.com>
Date: Sat, 2 Dec 2023 19:58:22 -0500
Subject: [PATCH] Improve SHPK documentation

---
 src/shpk.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/shpk.rs b/src/shpk.rs
index 266d408..d215320 100644
--- a/src/shpk.rs
+++ b/src/shpk.rs
@@ -78,15 +78,19 @@ struct SHPKHeader {
 }
 
 pub struct Shader {
+    /// The HLSL bytecode of this shader. The DX level used varies.
     pub bytecode: Vec<u8>
 }
 
 pub struct ShaderPackage {
+    /// The vertex shaders in this package
     pub vertex_shaders: Vec<Shader>,
+    /// The pixel (fragment) shaders in this package
     pub pixel_shaders: Vec<Shader>
 }
 
 impl ShaderPackage {
+    /// Reads an existing SHPK file
     pub fn from_existing(buffer: ByteSpan) -> Option<ShaderPackage> {
         let mut cursor = Cursor::new(buffer);
         let shpk_header = SHPKHeader::read(&mut cursor).unwrap();