From: Mikko Rasa <tdb@tdb.fi>
Date: Sat, 23 Jun 2012 18:21:02 +0000 (+0300)
Subject: Add descriptions to some functions
X-Git-Url: http://git.tdb.fi/?a=commitdiff_plain;h=a1ac20ac56a65a26d96665b81d066a3050057910;p=builder.git

Add descriptions to some functions
---

diff --git a/source/target.h b/source/target.h
index c1f9327..0f0afc6 100644
--- a/source/target.h
+++ b/source/target.h
@@ -75,9 +75,17 @@ public:
 	void set_tool(const Tool &);
 	const Tool *get_tool() const { return tool; }
 
+	/** Indicates if it's possible to build this target. */
 	bool is_buildable() const { return tool!=0; }
+
+	/** Indicates if this target needs rebuilding.  Only makes sense after the
+	target has been prepared. */
 	bool needs_rebuild() const { return state>PREPARING && state<UPTODATE; }
+
+	/** Returns the reason for rebuilding this target.  Only makes sense after
+	the target has been prepared. */
 	const std::string &get_rebuild_reason() const { return rebuild_reason; }
+
 	bool is_installable() const { return !install_location.empty(); }
 	const std::string &get_install_location() const { return install_location; }
 	void add_depend(Target *);