Add comments

[builder.git] / source / package.h

diff --git a/source/package.h b/source/package.h
index a1a9859136f7f262543f232391e480e6de2e915e..3d980f26ab19d501adf1486df69a25a6962a8943 100644 (file)
--- a/source/package.h
+++ b/source/package.h
@@ -11,9 +11,16 @@
 
 class Builder;
 
+/**
+A package is a distributable piece of software.  They consist of one or more
+Components and may depend on other packages.  Packages also have configuration
+to determine where files are installed and which features to include (features
+NYI).
+*/
 class Package
 {
 public:
+       /// Loads a package from a file.
        class Loader: public Msp::Parser::Loader
        {
        public:
@@ -31,18 +38,17 @@ public:
        };
 
        Package(Builder &, const std::string &, const Msp::Path::Path &);
-       Package(Builder &, const std::string &, const std::vector<std::string> &);
        void                set_path(const Msp::Path::Path &);
-       const std::string   &get_name() const       { return name; }
-       const Msp::Path::Path &get_source() const   { return source; }
-       const ComponentList &get_components() const { return components; }
-       bool                get_buildable() const   { return buildable; }
-       const Config        &get_config() const     { return config; }
-       const std::list<PackageRef> &get_requires() const { return requires; }
-       const BuildInfo     &get_build_info() const { return build_info; }
+       const std::string   &get_name() const           { return name; }
+       const Msp::Path::Path &get_source() const       { return source; }
+       const ComponentList &get_components() const     { return components; }
+       bool                get_buildable() const       { return buildable; }
+       const Config        &get_config() const         { return config; }
+       const PkgRefList    &get_requires() const       { return requires; }
+       const BuildInfo     &get_build_info() const     { return build_info; }
        const BuildInfo     &get_exported_binfo() const { return export_binfo; }
-       Builder             &get_builder() const    { return builder; }
-       bool                get_need_path() const   { return need_path; }
+       Builder             &get_builder() const        { return builder; }
+       bool                get_need_path() const       { return need_path; }
        void                resolve_refs();
        void                create_build_info();
        void                process_options(const RawOptionMap &);
@@ -58,21 +64,25 @@ private:
        };
        
        Builder       &builder;
+       
        std::string   name;
        std::string   version;
        std::string   description;
-       std::list<PackageRef> requires;
+       
+       bool          buildable;
+       Msp::Path::Path source;
+       PkgRefList    requires;
        BuildInfo     build_info;
        BuildInfo     export_binfo;
-       Msp::Path::Path source;
-       bool          buildable;
        ComponentList components;
        Config        config;
        bool          build_info_ready;
+
        bool          need_path;
        Msp::Path::Path path;
 
-       void init_buildable();
+       Package(Builder &, const std::string &, const std::vector<std::string> &);
+       void    init_buildable();
        unsigned get_install_flags();
 };