]> git.tdb.fi Git - builder.git/commitdiff
Add descriptions to some functions
authorMikko Rasa <tdb@tdb.fi>
Sat, 23 Jun 2012 18:21:02 +0000 (21:21 +0300)
committerMikko Rasa <tdb@tdb.fi>
Sun, 8 Jul 2012 21:08:54 +0000 (00:08 +0300)
source/target.h

index c1f932791b32f9288daf2731c4ca3b1ee35a9d2f..0f0afc6310b24d8fc88b924608d2a4bb2ec30aad 100644 (file)
@@ -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 *);