From 1f80099f45c3cd79370010d4eb7d0169e4ea93df Mon Sep 17 00:00:00 2001
From: "Stephen F. Booth" <me@sbooth.org>
Date: Mon, 9 Dec 2024 10:23:23 -0600
Subject: [PATCH] Add documentation on `fileType` meaning

---
 taglib/shn/shnproperties.h | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/taglib/shn/shnproperties.h b/taglib/shn/shnproperties.h
index 493c654d..f94638b1 100644
--- a/taglib/shn/shnproperties.h
+++ b/taglib/shn/shnproperties.h
@@ -52,7 +52,13 @@ namespace TagLib {
 
       //! Returns the Shorten file version (1-3).
       int shortenVersion() const;
-      //! Returns the Shorten file type.
+      //! Returns the file type (0-9).
+      //! 0 = 8-bit µ-law,
+      //! 1 = signed 8-bit PCM, 2 = unsigned 8-bit PCM,
+      //! 3 = signed big-endian 16-bit PCM, 4 = unsigned big-endian 16-bit PCM,
+      //! 5 = signed little-endian 16-bit PCM, 6 = unsigned little-endian 16-bit PCM,
+      //! 7 = 8-bit ITU-T G.711 µ-law, 8 = 8-bit µ-law,
+      //! 9 = 8-bit A-law, 10 = 8-bit ITU-T G.711 A-law
       int fileType() const;
       int bitsPerSample() const;
       unsigned long sampleFrames() const;