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) (unidiff) | |
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) (show 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 | |||
@@ -11,54 +11,54 @@ | |||
11 | 11 | ||
12 | namespace sitecing { | 12 | namespace sitecing { |
13 | using namespace std; | 13 | using namespace std; |
14 | 14 | ||
15 | /** | 15 | /** |
16 | * The factory class. Does the job similar to that which is done by make | 16 | * The factory class. Does the job similar to that which is done by make |
17 | * utility. | 17 | * utility. |
18 | */ | 18 | */ |
19 | class file_factory { | 19 | class file_factory { |
20 | public: | 20 | public: |
21 | /** | 21 | /** |
22 | * The recursion depth. | 22 | * The recursion depth. |
23 | */ | 23 | */ |
24 | int depth; | 24 | int depth; |
25 | /** | 25 | /** |
26 | * The list of files type. The list of strings, in fact. | 26 | * The list of files type. The list of strings, in fact. |
27 | */ | 27 | */ |
28 | typedef list<string> file_list_t; | 28 | typedef list<string> file_list_t; |
29 | 29 | ||
30 | file_factory() | 30 | file_factory() |
31 | : depth(0) { } | 31 | : depth(0) { } |
32 | 32 | ||
33 | /** | 33 | /** |
34 | * Fetch depndencies for the given file. | 34 | * Fetch depndencies for the given file. |
35 | * @param dst destination file. | 35 | * @param dst the destination file. |
36 | * @param deps where to put dependencies to. | 36 | * @param deps where to put dependencies to. |
37 | */ | 37 | */ |
38 | virtual void get_dependencies(const string& dst,file_list_t& deps) = 0; | 38 | virtual void get_dependencies(const string& dst,file_list_t& deps) = 0; |
39 | /** | 39 | /** |
40 | * Check if the destination is up to day. | 40 | * Check if the destination is up to day. |
41 | * @param the destination file. | 41 | * @param dst the destination file. |
42 | * @param deps if the deps pointer is non there, the dependencies | 42 | * @param deps if the deps pointer is non there, the dependencies |
43 | * retrieved will be stored there. | 43 | * retrieved will be stored there. |
44 | * @return true if yes. | 44 | * @return true if yes. |
45 | * @see get_dependencies() | 45 | * @see get_dependencies() |
46 | */ | 46 | */ |
47 | virtual bool is_uptodate(const string& dst,file_list_t* deps=0); | 47 | virtual bool is_uptodate(const string& dst,file_list_t* deps=0); |
48 | /** | 48 | /** |
49 | * Build the file requested. | 49 | * Build the file requested. |
50 | * @param dst the file requested. | 50 | * @param dst the file requested. |
51 | */ | 51 | */ |
52 | virtual void build(const string& dst) = 0; | 52 | virtual void build(const string& dst) = 0; |
53 | /** | 53 | /** |
54 | * Make the file requested, which means: build it, unless it's | 54 | * Make the file requested, which means: build it, unless it's |
55 | * uptodate. | 55 | * uptodate. |
56 | * @see is_uptodate() | 56 | * @see is_uptodate() |
57 | * @see build() | 57 | * @see build() |
58 | */ | 58 | */ |
59 | virtual void make(const string& dst); | 59 | virtual void make(const string& dst); |
60 | }; | 60 | }; |
61 | 61 | ||
62 | } | 62 | } |
63 | 63 | ||
64 | #endif /* __SITECING_FILE_FACTORY_H */ | 64 | #endif /* __SITECING_FILE_FACTORY_H */ |