From d6e2fa44ab9e6f7b8644b8e39260c9531b692fbb Mon Sep 17 00:00:00 2001
From: Franck Cuny <franck@fcuny.net>
Date: Sat, 28 Dec 2024 13:48:28 -0800
Subject: document the public types

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

diff --git a/src/apple_silicon/src/soc.rs b/src/apple_silicon/src/soc.rs
index fcf3ed3..17ff323 100644
--- a/src/apple_silicon/src/soc.rs
+++ b/src/apple_silicon/src/soc.rs
@@ -4,9 +4,13 @@ use std::process::Command;
 
 pub type Result<T> = std::result::Result<T, Error>;
 
+/// Information about the Silicon chip
 pub struct SocInfo {
+    /// The CPU brand name string
     pub cpu_brand_name: String,
+    /// Number of CPU cores
     pub num_cpu_cores: u16,
+    /// Number of GPU cores
     pub num_gpu_cores: u16,
 }
 
-- 
cgit v1.2.3