Documentation for alien.h

diff --git a/alien.h b/alien.h
index 9f061dc412224be3e1236b94191afb3b54ee5faa..77db1febc2239e3d12886ff7ee8e44e2a8edc90f 100644 (file)
--- a/alien.h
+++ b/alien.h
@@ -43,6 +43,11 @@ struct AlienPart : public AlienComponent {
        virtual void accept(Visitor &visitor) const;
 };
 
+/**
+ * Any type that's not registered is treated as an "Alien".
+ * This allows us to read files even if they contain things we're not aware of.
+ * The alien will consist of AlienComponents, some of which we may be able to read.
+ */
 class Alien : public Store {
        const TypePath d_path;
        std::vector<AlienComponent*> d_comps;