Mercurial > fife-parpg

comparison doc/templatefiles/sampleheader.h @ 0:4a0efb7baf70

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Datasets becomes the new trunk and retires after that :-)
author mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
date Sun, 29 Jun 2008 18:44:17 +0000
parents
children 90005975cdbb
comparison
equal deleted inserted replaced
-1:000000000000 0:4a0efb7baf70
1 /***************************************************************************
2 * Copyright (C) 2005-2007 by the FIFE Team *
3 * fife-public@lists.sourceforge.net *
4 * This file is part of FIFE. *
5 * *
6 * FIFE is free software; you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation; either version 2 of the License, or *
9 * (at your option) any later version. *
10 * *
11 * This program is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
14 * GNU General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program; if not, write to the *
18 * Free Software Foundation, Inc., *
19 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA *
20 ***************************************************************************/
21
22 #ifndef FIFE_POSSIBLESUBNAMESPACES_FOO_H
23 #define FIFE_POSSIBLESUBNAMESPACES_FOO_H
24
25 // Standard C++ library includes
26
27 // 3rd party library includes
28
29 // FIFE includes
30 // These includes are split up in two parts, separated by one empty line
31 // First block: files included from the FIFE root src directory
32 // Second block: files included from the same folder
33
34 namespace FIFE {
35
36 // FORWARD REFERENCES
37
38 /** A one line description of the class.
39 *
40 * A longer description.
41 *
42 * @see something
43 */
44 class Foo {
45 public:
46
47 // LIFECYCLE
48 /** Default constructor.
49 */
50 Foo();
51
52 /** Copy constructor.
53 *
54 * @param from The value to copy to this object.
55 */
56 Foo(const Foo& from);
57
58 /** Destructor.
59 */
60 ~Foo();
61
62 // OPERATORS
63 /** Assignment operator.
64 *
65 * @param from The value to assign to this object.
66 *
67 * @return A reference to this object.
68 */
69 Foo& operator=(Foo& from);
70
71 // OPERATIONS
72 // ACCESS
73 // INQUIRY
74
75 protected:
76 private:
77 };
78
79 // INLINE METHODS
80 //
81
82 // EXTERNAL REFERENCES
83 //
84
85 } //FIFE
86
87 #endif