From 1094fd9a612a3d02109b04346ee17da75c701449 Mon Sep 17 00:00:00 2001
From: Tomáš Znamenáček
Date: Thu, 7 Aug 2014 18:20:37 +0200
Subject: Added header documentation.

---
 Framework/MASDictionaryTransformer.h | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

(limited to 'Framework/MASDictionaryTransformer.h')

diff --git a/Framework/MASDictionaryTransformer.h b/Framework/MASDictionaryTransformer.h
index f0eb558..eced1bb 100644
--- a/Framework/MASDictionaryTransformer.h
+++ b/Framework/MASDictionaryTransformer.h
@@ -1,4 +1,19 @@
 extern NSString *const MASDictionaryTransformerName;
 
+/**
+    @brief Converts shortcuts for storage in user defaults.
+
+    User defaults can’t stored custom types directly, they have to
+    be serialized to @p NSData or some other supported type like an
+    @p NSDictionary. In Cocoa Bindings, the conversion can be done
+    using value transformers like this one.
+
+    There’s a built-in transformer (@p NSKeyedUnarchiveFromDataTransformerName)
+    that converts any @p NSCoding types to @p NSData, but with shortcuts
+    it makes sense to use a dictionary instead – the defaults look better
+    when inspected with the @p defaults command-line utility and the
+    format is compatible with an older sortcut library called Shortcut
+    Recorder.
+*/
 @interface MASDictionaryTransformer : NSValueTransformer
 @end
-- 
cgit v1.2.3