author | Michael Krelin <hacker@klever.net> | 2007-03-04 00:28:39 (UTC) |
---|---|---|
committer | Michael Krelin <hacker@klever.net> | 2007-03-04 00:28:39 (UTC) |
commit | a3f38aafb288db5791b8dea34154cacc3c039971 (patch) (side-by-side diff) | |
tree | b7f735ef9fde95de5935c1784d8d9486a3e4cf10 /include/sitecing/file_factory.h | |
parent | ca2207bcf18ed5b0dd1a0e370e9973d717ff87c9 (diff) | |
download | sitecing-a3f38aafb288db5791b8dea34154cacc3c039971.zip sitecing-a3f38aafb288db5791b8dea34154cacc3c039971.tar.gz sitecing-a3f38aafb288db5791b8dea34154cacc3c039971.tar.bz2 |
some doxygen improvements
Diffstat (limited to 'include/sitecing/file_factory.h') (more/less context) (ignore whitespace changes)
-rw-r--r-- | include/sitecing/file_factory.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/include/sitecing/file_factory.h b/include/sitecing/file_factory.h index 7ec82da..43a27bb 100644 --- a/include/sitecing/file_factory.h +++ b/include/sitecing/file_factory.h @@ -1,64 +1,64 @@ #ifndef __SITECING_FILE_FACTORY_H #define __SITECING_FILE_FACTORY_H #include <string> #include <list> /** * @file * @brief the file_factory class declaration. */ namespace sitecing { using namespace std; /** * The factory class. Does the job similar to that which is done by make * utility. */ class file_factory { public: /** * The recursion depth. */ int depth; /** * The list of files type. The list of strings, in fact. */ typedef list<string> file_list_t; file_factory() : depth(0) { } /** * Fetch depndencies for the given file. - * @param dst destination file. + * @param dst the destination file. * @param deps where to put dependencies to. */ virtual void get_dependencies(const string& dst,file_list_t& deps) = 0; /** * Check if the destination is up to day. - * @param the destination file. + * @param dst the destination file. * @param deps if the deps pointer is non there, the dependencies * retrieved will be stored there. * @return true if yes. * @see get_dependencies() */ virtual bool is_uptodate(const string& dst,file_list_t* deps=0); /** * Build the file requested. * @param dst the file requested. */ virtual void build(const string& dst) = 0; /** * Make the file requested, which means: build it, unless it's * uptodate. * @see is_uptodate() * @see build() */ virtual void make(const string& dst); }; } #endif /* __SITECING_FILE_FACTORY_H */ |