From b9e54363efe2282d609f3d66ce656426aa49f7d6 Mon Sep 17 00:00:00 2001 From: Garrett Moon Date: Wed, 5 Oct 2016 17:33:47 -0700 Subject: [PATCH] Documenting ASWeakProxy (#2328) --- AsyncDisplayKit/Details/ASWeakProxy.h | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/AsyncDisplayKit/Details/ASWeakProxy.h b/AsyncDisplayKit/Details/ASWeakProxy.h index a3c2276b06..95f195e134 100644 --- a/AsyncDisplayKit/Details/ASWeakProxy.h +++ b/AsyncDisplayKit/Details/ASWeakProxy.h @@ -14,8 +14,20 @@ @interface ASWeakProxy : NSProxy +/** + * @return target The target which will be forwarded all messages sent to the weak proxy. + */ @property (nonatomic, weak, readonly) id target; +/** + * An object which forwards messages to a target which it weakly references + * + * @discussion This class is useful for breaking retain cycles. You can pass this in place + * of the target to something which creates a strong reference. All messages sent to the + * proxy will be passed onto the target. + * + * @return an instance of ASWeakProxy + */ + (instancetype)weakProxyWithTarget:(id)target; @end