Add comments

[builder.git] / source / target.cpp

diff --git a/source/target.cpp b/source/target.cpp
index e03428837838afdbd78447862075f4db66d082b6..1f4ace9d92c1d7b79122129a99b9781814e0f0d5 100644 (file)
--- a/source/target.cpp
+++ b/source/target.cpp
@@ -8,6 +8,11 @@
 using namespace std;
 using namespace Msp;
 
+/**
+Tries to locate a target that will help getting this target built.  If all
+dependencies are up-to-date, returns this target.  If there are no targets
+ready to be built (maybe because they are being built right now), returns 0.
+*/
 Target *Target::get_buildable_target()
 {
        bool self_ok=true;
@@ -32,17 +37,28 @@ void Target::add_depend(Target *dep)
        dep->rdepends.push_back(this);
 }
 
+/**
+Prepares the target by recursively preparing dependencies, then checking
+whether rebuilding is needed.  A flag is used to prevent unnecessary
+executions.
+*/
 void Target::prepare()
 {
        if(prepared)
                return;
 
+       prepared=true;
        for(TargetList::iterator i=depends.begin(); i!=depends.end(); ++i)
                (*i)->prepare();
 
        check_rebuild();
+
 }
 
+/**
+Returns the number of targets that need to be rebuilt in order to get this
+target up-to-date.
+*/
 unsigned Target::count_rebuild()
 {
        if(counted)
@@ -55,6 +71,9 @@ unsigned Target::count_rebuild()
        return count;
 }
 
+/**
+Changes the mtime of the target to the current time.
+*/
 void Target::touch()
 {
        mtime=Time::now();
@@ -82,6 +101,9 @@ void Target::mark_rebuild(const std::string &reason)
        rebuild_reason=reason;
 }
 
+/**
+Checks if this target needs to be rebuilt and why.
+*/
 void Target::check_rebuild()
 {
        if(!buildable)
@@ -105,6 +127,10 @@ void Target::check_rebuild()
                mark_rebuild("Package options changed");
 }
 
+/**
+Hooks the target up with the given action, then returns it.  This should be
+called from the public build() function of buildable targets.
+*/
 Action *Target::build(Action *action)
 {
        building=true;
@@ -112,6 +138,9 @@ Action *Target::build(Action *action)
        return action;
 }
 
+/**
+Handles for the build_done signal of Action.
+*/
 void Target::build_done()
 {
        building=false;