From: Gert van Valkenhoef <g.h.m.van.valkenhoef@rug.nl>
Date: Wed, 9 Nov 2011 18:16:23 +0000 (+0000)
Subject: Documentation for alien.h
X-Git-Url: http://deadsoftware.ru/gitweb?p=odcread.git;a=commitdiff_plain;h=75cf4599cf50d987efa2e402243c2680640ef339

Documentation for alien.h
---

diff --git a/alien.h b/alien.h
index 9f061dc..77db1fe 100644
--- 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;