aboutsummaryrefslogtreecommitdiff
path: root/src/stable/archival.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/stable/archival.h')
-rw-r--r--src/stable/archival.h66
1 files changed, 33 insertions, 33 deletions
diff --git a/src/stable/archival.h b/src/stable/archival.h
index 664bc98..78faffb 100644
--- a/src/stable/archival.h
+++ b/src/stable/archival.h
@@ -12,40 +12,40 @@
12 12
13namespace Bu 13namespace Bu
14{ 14{
15 /** 15 /**
16 * The base class for any class you want to archive. Simply include this as 16 * The base class for any class you want to archive. Simply include this as
17 * a base class, implement the purely virtual archive function and you've 17 * a base class, implement the purely virtual archive function and you've
18 * got an easily archiveable class. 18 * got an easily archiveable class.
19 * 19 *
20 * Archival: "of or pertaining to archives or valuable records; contained 20 * Archival: "of or pertaining to archives or valuable records; contained
21 * in or comprising such archives or records." 21 * in or comprising such archives or records."
22 */ 22 */
23 class Archival 23 class Archival
24 { 24 {
25 public: 25 public:
26 /** 26 /**
27 * Does nothing, here for completeness. 27 * Does nothing, here for completeness.
28 */ 28 */
29 Archival(); 29 Archival();
30 30
31 /** 31 /**
32 * Here to ensure the deconstructor is virtual. 32 * Here to ensure the deconstructor is virtual.
33 */ 33 */
34 virtual ~Archival(); 34 virtual ~Archival();
35 35
36 /** 36 /**
37 * This is the main workhorse of the archive system, just override and 37 * This is the main workhorse of the archive system, just override and
38 * you've got a archiveable class. A reference to the Archive 38 * you've got a archiveable class. A reference to the Archive
39 * used is passed in as your only parameter, query it to discover if 39 * used is passed in as your only parameter, query it to discover if
40 * you are loading or saving. 40 * you are loading or saving.
41 * @param ar A reference to the Archive object to use. 41 * @param ar A reference to the Archive object to use.
42 */ 42 */
43 virtual void archive( class ArchiveBase &ar )=0; 43 virtual void archive( class ArchiveBase &ar )=0;
44 }; 44 };
45 45
46 ArchiveBase &operator<<(ArchiveBase &, const class Bu::Archival &); 46 ArchiveBase &operator<<(ArchiveBase &, const class Bu::Archival &);
47 ArchiveBase &operator<<(ArchiveBase &, class Bu::Archival &); 47 ArchiveBase &operator<<(ArchiveBase &, class Bu::Archival &);
48 ArchiveBase &operator>>(ArchiveBase &, class Bu::Archival &); 48 ArchiveBase &operator>>(ArchiveBase &, class Bu::Archival &);
49 49
50} 50}
51 51