Comment updates

[builder.git] / source / target.h

diff --git a/source/target.h b/source/target.h
index d6ed43860315b1508356d66024d8852258f70af7..03b87557873e111a2b0eb986b90fb97b1cbe959a 100644 (file)
--- a/source/target.h
+++ b/source/target.h
@@ -55,19 +55,16 @@ public:
        const Package *get_package() const { return package; }
        const Component *get_component() const { return component; }
 
-       /**
-       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.
-       */
+       /** 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. */
        virtual Target *get_buildable_target();
 
-       /**
-       If this target is a proxy for another (such as Install or Symlink), return
-       that target.  Otherwise, return the target itself.
+       /** If this target is a proxy for another (such as Install), return that
+       target.  Otherwise, return the target itself.
 
-       Implementors should call the function recursively to find the final target.
-       */
+       Implementors should call the function recursively to find the final target. */
        virtual Target *get_real_target() { return this; }
 
        void set_tool(const Tool &);
@@ -84,28 +81,19 @@ public:
        /** Finds dependencies for the target. */
        virtual void find_depends() { }
 
-       /**
-       Prepares the target by recursively preparing dependencies, then checking
-       whether rebuilding is needed.  A flag is used to prevent unnecessary
-       executions.
-       */
+       /** Prepares the target by finding dependencies, recursively preparing them
+       and then checking whether rebuilding is needed. */
        virtual void prepare();
 
-       /**
-       Starts building the target.  Returns the Action used for building.
-       */
+       /** Starts building the target.  Returns the Action used for building. */
        Task *build();
 protected:
        void mark_rebuild(const std::string &);
 
-       /**
-       Checks if the target needs to be rebuilt and why.
-       */
+       /** Checks if the target needs to be rebuilt and why. */
        virtual void check_rebuild() = 0;
 
-       /**
-       Handler for the build_finished signal of Task.
-       */
+       /** Handler for Task::signal_finished. */
        virtual void build_finished(bool);
 };