From: Mikko Rasa Date: Mon, 23 Jul 2012 19:52:13 +0000 (+0300) Subject: Comment tweaks X-Git-Url: http://git.tdb.fi/?a=commitdiff_plain;h=9e3a8d36093be89242db0c472ffd8fe5c61ab0ec;p=builder.git Comment tweaks --- diff --git a/source/filetarget.h b/source/filetarget.h index 851085b..a48e1ab 100644 --- a/source/filetarget.h +++ b/source/filetarget.h @@ -31,9 +31,7 @@ public: bool is_installable() const { return !install_location.empty(); } const Msp::FS::Path &get_install_location() const { return install_location; } - /** - Changes the mtime of the target to the current time. - */ + /// Changes the mtime of the target to the current time. void touch(); protected: diff --git a/source/packagemanager.h b/source/packagemanager.h index 05f5ebe..2fbaca1 100644 --- a/source/packagemanager.h +++ b/source/packagemanager.h @@ -51,14 +51,15 @@ public: const PackageMap &get_packages() const { return packages; } - /** Locates a package and creates it if necessary. */ + /** Locates a package and loads it if necessary. */ Package *find_package(const std::string &); private: std::string run_pkgconfig(const std::string &, const std::string &); /** Determines the source directory of a package. Pkg-config is consulted - first, and if it fails, the package path is searched for matches. */ + first, and if it fails, the package path is searched for matches. The + package is expected to be located in a directory named after itself. */ Msp::FS::Path get_package_location(const std::string &); /** Determines the file containing a binary package. The file is expected diff --git a/source/tool.h b/source/tool.h index 6aee38b..d5d7e78 100644 --- a/source/tool.h +++ b/source/tool.h @@ -61,7 +61,7 @@ public: /// Creates a source file appropriate for this tool. virtual Target *create_source(const Component &, const Msp::FS::Path &) const { return 0; } - /** Creates a package-less source file appropriate for this too. This is + /** Creates a package-less source file appropriate for this tool. This is called during dependency discovery when no package has created a target for the file. */ virtual Target *create_source(const Msp::FS::Path &) const { return 0; }