summaryrefslogtreecommitdiffabout
authorMichael Krelin <hacker@klever.net>2007-03-04 12:14:18 (UTC)
committer Michael Krelin <hacker@klever.net>2007-03-04 12:14:18 (UTC)
commit88e7e2ac30d181e30a7c4fa36d0029990136efb6 (patch) (unidiff)
treee17c49cafb1400b86befa026bdad581526d4747e
parentd0540221d96199532046182649610c8d42252be1 (diff)
downloadsitecing-88e7e2ac30d181e30a7c4fa36d0029990136efb6.zip
sitecing-88e7e2ac30d181e30a7c4fa36d0029990136efb6.tar.gz
sitecing-88e7e2ac30d181e30a7c4fa36d0029990136efb6.tar.bz2
typo corrected
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--include/sitecing/file_factory.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/include/sitecing/file_factory.h b/include/sitecing/file_factory.h
index 43a27bb..f23682f 100644
--- a/include/sitecing/file_factory.h
+++ b/include/sitecing/file_factory.h
@@ -1,64 +1,64 @@
1#ifndef __SITECING_FILE_FACTORY_H 1#ifndef __SITECING_FILE_FACTORY_H
2#define __SITECING_FILE_FACTORY_H 2#define __SITECING_FILE_FACTORY_H
3 3
4#include <string> 4#include <string>
5#include <list> 5#include <list>
6 6
7/** 7/**
8 * @file 8 * @file
9 * @brief the file_factory class declaration. 9 * @brief the file_factory class declaration.
10 */ 10 */
11 11
12namespace sitecing { 12namespace 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 dependencies for the given file.
35 * @param dst the 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 dst 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 */