Mercurial > fife-parpg
diff doc/templatefiles/sampleheader.h @ 0:4a0efb7baf70
* 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 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/templatefiles/sampleheader.h Sun Jun 29 18:44:17 2008 +0000 @@ -0,0 +1,87 @@ +/*************************************************************************** + * Copyright (C) 2005-2007 by the FIFE Team * + * fife-public@lists.sourceforge.net * + * This file is part of FIFE. * + * * + * FIFE is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA * + ***************************************************************************/ + +#ifndef FIFE_POSSIBLESUBNAMESPACES_FOO_H +#define FIFE_POSSIBLESUBNAMESPACES_FOO_H + +// Standard C++ library includes + +// 3rd party library includes + +// FIFE includes +// These includes are split up in two parts, separated by one empty line +// First block: files included from the FIFE root src directory +// Second block: files included from the same folder + +namespace FIFE { + + // FORWARD REFERENCES + + /** A one line description of the class. + * + * A longer description. + * + * @see something + */ + class Foo { + public: + + // LIFECYCLE + /** Default constructor. + */ + Foo(); + + /** Copy constructor. + * + * @param from The value to copy to this object. + */ + Foo(const Foo& from); + + /** Destructor. + */ + ~Foo(); + + // OPERATORS + /** Assignment operator. + * + * @param from The value to assign to this object. + * + * @return A reference to this object. + */ + Foo& operator=(Foo& from); + + // OPERATIONS + // ACCESS + // INQUIRY + + protected: + private: + }; + + // INLINE METHODS + // + + // EXTERNAL REFERENCES + // + +} //FIFE + +#endif