Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/doc/src/modules/questsystem/QuestNotification.cc @ 7297

Last change on this file since 7297 was 7297, checked in by landauf, 14 years ago

fixed lots of Doxygen warnings

Note: Doxygen prints a warning if only a part of the parameters of a function are documented.

Added documentation for missing parameters (as good as I could), removed documentation of obsolete parameters and fixed names of renamed parameters.
Some parameters are tagged with "FIXME", please replace this with an appropriate documentation if you know what it does.

  • Property svn:eol-style set to native
File size: 2.1 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See thes
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Damian 'Mozork' Frick
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29#include "QuestNotification.h"
30#include "core/CoreIncludes.h"
31
32namespace orxonox {
33
34    /*static*/ const std::string QuestNotification::SENDER("questsystem");
35
36    CreateUnloadableFactory(QuestNotification);
37
38    /**
39    @brief
40        Default Constructor. Creates a useless QuestNotification.
41    */
42    QuestNotification::QuestNotification(BaseObject* creator) : Notification(creator)
43    {
44        RegisterObject(QuestNotification);
45    }
46
47    /**
48    @brief
49        Creates a QuestNotification with the input message.
50    @param creator
51        The creator of this object
52    @param message
53        The message to be sent.
54    */
55    QuestNotification::QuestNotification(BaseObject* creator, const std::string & message) : Notification(creator, message)
56    {
57        RegisterObject(QuestNotification);
58    }
59
60    /**
61    @brief
62        Destructor.
63    */
64    QuestNotification::~QuestNotification()
65    {
66
67    }
68
69    /**
70    @brief
71        Send the QuestNotification.
72    @return
73        Returns true if successful.
74    */
75    bool QuestNotification::send(void)
76    {
77        return this->Notification::send(QuestNotification::SENDER);
78    }
79
80
81}
Note: See TracBrowser for help on using the repository browser.