Add comments

[builder.git] / source / component.h

diff --git a/source/component.h b/source/component.h
index 04a0a41103b858a2a483c7b97e8ff75c2b3fcb68..663132ad3f7ede8c6fc994f6112c77c83c531ee9 100644 (file)
--- a/source/component.h
+++ b/source/component.h
@@ -10,9 +10,16 @@
 
 class Package;
 
+/**
+Components specify things to be built.  Each component may build one binary (it
+may also build none), as well as install a bunch of headers.  Components inherit
+dependencies and build info from the package they belong to, and may also add
+their own.
+*/
 class Component
 {
 public:
+       /// Loads a Component from file.  Used from Package::Loader.
        class Loader: public Msp::Parser::Loader
        {
        public:
@@ -52,7 +59,7 @@ protected:
        bool        install;
        std::string install_headers;
        BuildInfo   build_info;
-       std::list<PackageRef> requires;
+       PkgRefList  requires;
 };
 typedef std::list<Component> ComponentList;