From 2cd3443fbbb498f06227ed44db0c6a749cafdb76 Mon Sep 17 00:00:00 2001
From: Tycho <work.tycho+git@gmail.com>
Date: Mon, 14 Jul 2014 21:21:17 +0100
Subject: Added documentation

---
 src/Blocks/ClearMetaOnDrop.h | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'src/Blocks')

diff --git a/src/Blocks/ClearMetaOnDrop.h b/src/Blocks/ClearMetaOnDrop.h
index e6d26863a..3f8c33819 100644
--- a/src/Blocks/ClearMetaOnDrop.h
+++ b/src/Blocks/ClearMetaOnDrop.h
@@ -1,6 +1,12 @@
 
 #pragma once
 
+// mixin for use to clear meta values when the block is converted to a pickup
+
+// Usage: inherit from this class, passing the parent class as the parameter Base
+// For example to use in class Foo which should inherit Bar use 
+// class Foo : public cClearMetaOnDrop<Bar>;
+
 template<class Base>
 class cClearMetaOnDrop : public Base
 {
-- 
cgit v1.2.3