Add comments

[builder.git] / source / target.h

diff --git a/source/target.h b/source/target.h
index eb46d9fe7116125798f4e7920baf71f5c87c8260..fa744ac75f341fef278d9fe953a6654e0e317387 100644 (file)
--- a/source/target.h
+++ b/source/target.h
@@ -12,6 +12,10 @@ class Package;
 class Target;
 typedef std::list<Target *> TargetList;
 
+/**
+Targets make up the build graph.  This class is a base for all target types and
+handles many common tasks.  Most targets are associated with a file.
+*/
 class Target
 {
 public:
@@ -27,7 +31,12 @@ public:
        void               add_depend(Target *);
        virtual void       find_depends()              { deps_ready=true; }
        virtual void       prepare();
+       
+       /**
+       Creates and returns an Action suitable for building this target.
+       */
        virtual Action     *build()=0;
+       
        void               reset_count()               { counted=false; }
        virtual unsigned   count_rebuild();
        void               touch();