[Orxonox-commit 2592] r7297 - in code/branches/doc/src: libraries/core libraries/core/command libraries/core/input libraries/network libraries/network/synchronisable libraries/tools libraries/util modules/notifications modules/objects modules/objects/triggers modules/overlays modules/overlays/hud modules/overlays/stats modules/pickup modules/pickup/items modules/questsystem orxonox/controllers orxonox/graphics orxonox/interfaces orxonox/overlays orxonox/worldentities
landauf at orxonox.net
landauf at orxonox.net
Tue Aug 31 20:37:29 CEST 2010
Author: landauf
Date: 2010-08-31 20:37:29 +0200 (Tue, 31 Aug 2010)
New Revision: 7297
Modified:
code/branches/doc/src/libraries/core/BaseObject.cc
code/branches/doc/src/libraries/core/CommandLineParser.cc
code/branches/doc/src/libraries/core/CommandLineParser.h
code/branches/doc/src/libraries/core/ConfigValueContainer.h
code/branches/doc/src/libraries/core/CoreIncludes.h
code/branches/doc/src/libraries/core/DynLibManager.h
code/branches/doc/src/libraries/core/GUIManager.cc
code/branches/doc/src/libraries/core/Identifier.h
code/branches/doc/src/libraries/core/Language.cc
code/branches/doc/src/libraries/core/Namespace.cc
code/branches/doc/src/libraries/core/ObjectListBase.cc
code/branches/doc/src/libraries/core/ObjectListBase.h
code/branches/doc/src/libraries/core/ObjectListIterator.h
code/branches/doc/src/libraries/core/Resource.h
code/branches/doc/src/libraries/core/XMLPort.h
code/branches/doc/src/libraries/core/command/TclThreadList.h
code/branches/doc/src/libraries/core/command/TclThreadManager.cc
code/branches/doc/src/libraries/core/input/InputManager.cc
code/branches/doc/src/libraries/core/input/InputManager.h
code/branches/doc/src/libraries/core/input/KeyBinder.cc
code/branches/doc/src/libraries/network/ClientInformation.cc
code/branches/doc/src/libraries/network/synchronisable/Synchronisable.cc
code/branches/doc/src/libraries/tools/ResourceCollection.cc
code/branches/doc/src/libraries/tools/ResourceCollection.h
code/branches/doc/src/libraries/tools/ResourceLocation.cc
code/branches/doc/src/libraries/tools/ResourceLocation.h
code/branches/doc/src/libraries/tools/Timer.cc
code/branches/doc/src/libraries/tools/Timer.h
code/branches/doc/src/libraries/util/Convert.h
code/branches/doc/src/libraries/util/Exception.h
code/branches/doc/src/libraries/util/OutputHandler.cc
code/branches/doc/src/libraries/util/StringUtils.cc
code/branches/doc/src/libraries/util/SubString.cc
code/branches/doc/src/libraries/util/SubString.h
code/branches/doc/src/modules/notifications/Notification.cc
code/branches/doc/src/modules/notifications/NotificationQueue.cc
code/branches/doc/src/modules/notifications/NotificationQueue.h
code/branches/doc/src/modules/objects/Planet.cc
code/branches/doc/src/modules/objects/triggers/DistanceMultiTrigger.h
code/branches/doc/src/modules/objects/triggers/MultiTrigger.cc
code/branches/doc/src/modules/overlays/FadeoutText.h
code/branches/doc/src/modules/overlays/GUIOverlay.cc
code/branches/doc/src/modules/overlays/GUIOverlay.h
code/branches/doc/src/modules/overlays/OverlayText.cc
code/branches/doc/src/modules/overlays/OverlayText.h
code/branches/doc/src/modules/overlays/hud/HUDBar.cc
code/branches/doc/src/modules/overlays/hud/HUDBar.h
code/branches/doc/src/modules/overlays/hud/HUDHealthBar.h
code/branches/doc/src/modules/overlays/hud/HUDNavigation.cc
code/branches/doc/src/modules/overlays/hud/HUDNavigation.h
code/branches/doc/src/modules/overlays/hud/HUDRadar.cc
code/branches/doc/src/modules/overlays/hud/HUDRadar.h
code/branches/doc/src/modules/overlays/stats/Scoreboard.cc
code/branches/doc/src/modules/overlays/stats/Scoreboard.h
code/branches/doc/src/modules/overlays/stats/Stats.cc
code/branches/doc/src/modules/overlays/stats/Stats.h
code/branches/doc/src/modules/pickup/DroppedPickup.cc
code/branches/doc/src/modules/pickup/Pickup.cc
code/branches/doc/src/modules/pickup/PickupCollection.cc
code/branches/doc/src/modules/pickup/PickupCollectionIdentifier.cc
code/branches/doc/src/modules/pickup/PickupSpawner.cc
code/branches/doc/src/modules/pickup/items/SpeedPickup.cc
code/branches/doc/src/modules/questsystem/AddQuestHint.cc
code/branches/doc/src/modules/questsystem/Quest.cc
code/branches/doc/src/modules/questsystem/QuestEffectBeacon.cc
code/branches/doc/src/modules/questsystem/QuestNotification.cc
code/branches/doc/src/orxonox/controllers/ArtificialController.cc
code/branches/doc/src/orxonox/graphics/Light.h
code/branches/doc/src/orxonox/interfaces/Pickupable.h
code/branches/doc/src/orxonox/overlays/GUISheet.cc
code/branches/doc/src/orxonox/overlays/GUISheet.h
code/branches/doc/src/orxonox/overlays/InGameConsole.cc
code/branches/doc/src/orxonox/overlays/OrxonoxOverlay.cc
code/branches/doc/src/orxonox/overlays/OrxonoxOverlay.h
code/branches/doc/src/orxonox/overlays/OverlayGroup.cc
code/branches/doc/src/orxonox/overlays/OverlayGroup.h
code/branches/doc/src/orxonox/worldentities/WorldEntity.cc
Log:
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.
Modified: code/branches/doc/src/libraries/core/BaseObject.cc
===================================================================
--- code/branches/doc/src/libraries/core/BaseObject.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/core/BaseObject.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -115,7 +115,7 @@
/**
@brief XML loading and saving.
@param xmlelement The XML-element
- @param loading Loading (true) or saving (false)
+ @param mode The mode defines the operation that is being executed: loading or saving the object (from or to XML respectively)
*/
void BaseObject::XMLPort(Element& xmlelement, XMLPort::Mode mode)
{
@@ -140,7 +140,7 @@
/**
@brief Defines the possible event states of this object and parses eventsources from an XML file.
@param xmlelement The XML-element
- @param loading Loading (true) or saving (false)
+ @param mode The mode defines the operation that is being executed: loading or saving the object (from or to XML respectively)
*/
void BaseObject::XMLEventPort(Element& xmlelement, XMLPort::Mode mode)
{
Modified: code/branches/doc/src/libraries/core/CommandLineParser.cc
===================================================================
--- code/branches/doc/src/libraries/core/CommandLineParser.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/core/CommandLineParser.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -125,6 +125,8 @@
a whole string, simply use getAllStrings() of SubString.
@param arguments
Vector of space separated strings.
+ @param bParsingFile
+ FIXME - add doc!
*/
void CommandLineParser::_parse(const std::vector<std::string>& arguments, bool bParsingFile)
{
@@ -243,6 +245,8 @@
Full name of the argument
@param value
String containing the value
+ @param bParsingFile
+ FIXME - add doc!
*/
void CommandLineParser::checkFullArgument(const std::string& name, const std::string& value, bool bParsingFile)
{
@@ -260,6 +264,8 @@
Shotcut to the argument
@param value
String containing the value
+ @param bParsingFile
+ FIXME - add doc!
*/
void CommandLineParser::checkShortcut(const std::string& shortcut, const std::string& value, bool bParsingFile)
{
Modified: code/branches/doc/src/libraries/core/CommandLineParser.h
===================================================================
--- code/branches/doc/src/libraries/core/CommandLineParser.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/core/CommandLineParser.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -206,6 +206,8 @@
Name of the argument. Shortcut can be added later.
@param defaultValue
Default value that is used when argument was not given.
+ @param bCommandLineOnly
+ FIXME - add doc!
*/
template <class T>
CommandLineArgument& CommandLineParser::addArgument(const std::string& name, T defaultValue, bool bCommandLineOnly)
Modified: code/branches/doc/src/libraries/core/ConfigValueContainer.h
===================================================================
--- code/branches/doc/src/libraries/core/ConfigValueContainer.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/core/ConfigValueContainer.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -116,8 +116,10 @@
@brief Constructor: Converts the default-value to a string, checks the config-file for a changed value, sets the intern value variable.
@param type The type of the corresponding config-file
@param identifier The identifier of the class the variable belongs to
+ @param sectionname Name of the section the configValue should be put in.
@param varname The name of the variable
@param defvalue The default-value
+ @param value Only needed do determine the right type.
*/
template <class D, class V>
ConfigValueContainer(ConfigFileType::Value type, Identifier* identifier, const std::string& sectionname, const std::string& varname, const std::vector<D>& defvalue, const std::vector<V>& value)
Modified: code/branches/doc/src/libraries/core/CoreIncludes.h
===================================================================
--- code/branches/doc/src/libraries/core/CoreIncludes.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/core/CoreIncludes.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -100,7 +100,7 @@
{
/**
@brief Returns the Identifier with a given name.
- @param String The name of the class
+ @param name The name of the class
*/
inline Identifier* ClassByString(const std::string& name)
{
@@ -109,7 +109,7 @@
/**
@brief Returns the Identifier with a given lowercase name.
- @param String The lowercase name of the class
+ @param name The lowercase name of the class
*/
inline Identifier* ClassByLowercaseString(const std::string& name)
{
@@ -118,7 +118,7 @@
/**
@brief Returns the Identifier with a given network ID.
- @param networkID The network ID of the class
+ @param id The network ID of the class
*/
inline Identifier* ClassByID(uint32_t id)
{
@@ -129,7 +129,7 @@
@brief Returns the Identifier with a given 'this' pointer.
@note This of course only works with OrxonoxClasses.
The only use is in conjunction with macros that don't know the class type.
- @param Pointer to an OrxonoxClass
+ @param object Pointer to an OrxonoxClass
*/
template <class T>
inline Identifier* ClassByObjectType(const T* object)
Modified: code/branches/doc/src/libraries/core/DynLibManager.h
===================================================================
--- code/branches/doc/src/libraries/core/DynLibManager.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/core/DynLibManager.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -55,30 +55,38 @@
DynLibList mLibList;
public:
- /** Default constructor.
- @note
- <br>Should never be called as the singleton is automatically
- created during the creation of the Root object.
- @see
- Root::Root
+ /**
+ @brief
+ Default constructor.
+ @note
+ Should never be called as the singleton is automatically
+ created during the creation of the Root object.
+ @see
+ Root::Root
*/
DynLibManager();
- /** Default destructor.
- @see
- Root::~Root
+ /**
+ @brief
+ Default destructor.
+ @see
+ Root::~Root
*/
virtual ~DynLibManager();
- /** Loads the passed library.
- @param
- filename The name of the library. The extension can be omitted
+ /**
+ @brief
+ Loads the passed library.
+ @param filename
+ The name of the library. The extension can be omitted
*/
DynLib* load(const std::string& filename);
- /** Unloads the passed library.
- @param
- filename The name of the library. The extension can be omitted
+ /**
+ @brief
+ Unloads the passed library.
+ @param lib
+ A pointer to the library object
*/
void unload(DynLib* lib);
Modified: code/branches/doc/src/libraries/core/GUIManager.cc
===================================================================
--- code/branches/doc/src/libraries/core/GUIManager.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/core/GUIManager.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -109,8 +109,6 @@
The log is set up and connected to the CEGUILogger.
After Lua setup tolua++-elements are linked to Lua-state to give Lua access to C++-code.
Finally initial Lua code is executed (maybe we can do this with the CEGUI startup script automatically).
- @param renderWindow
- Ogre's render window. Without this, the GUI cannot be displayed.
@return true if success, otherwise false
*/
GUIManager::GUIManager(const std::pair<int, int>& mousePosition)
@@ -236,6 +234,8 @@
Displays specified GUI on screen
@param name
The name of the GUI
+ @param bHidePrevious
+ FIXME - add doc!
The function executes the Lua function with the same name in case the GUIManager is ready.
*/
Modified: code/branches/doc/src/libraries/core/Identifier.h
===================================================================
--- code/branches/doc/src/libraries/core/Identifier.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/core/Identifier.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -386,6 +386,8 @@
/**
@brief Adds an object of the given type to the ObjectList.
@param object The object to add
+ @param className The name of the class T
+ @param bRootClass True if this is a root class (i.e. it inherits directly from OrxonoxClass)
*/
template <class T>
bool ClassIdentifier<T>::initialiseObject(T* object, const std::string& className, bool bRootClass)
Modified: code/branches/doc/src/libraries/core/Language.cc
===================================================================
--- code/branches/doc/src/libraries/core/Language.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/core/Language.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -167,6 +167,7 @@
/**
@brief Returns the localisation of a given entry.
@param label The label of the entry
+ @param bError If true, an error is printed if the label doesn't exist and the default localisation is returned. If false, no error is printed and an empty string is returned.
@return The localisation
*/
const std::string& Language::getLocalisation(const LanguageEntryLabel& label, bool bError) const
Modified: code/branches/doc/src/libraries/core/Namespace.cc
===================================================================
--- code/branches/doc/src/libraries/core/Namespace.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/core/Namespace.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -54,12 +54,6 @@
delete (*it);
}
- /**
- @brief XML loading and saving.
- @param xmlelement The XML-element
- @param loading Loading (true) or saving (false)
- @return The XML-element
- */
void Namespace::XMLPort(Element& xmlelement, XMLPort::Mode mode)
{
SUPER(Namespace, XMLPort, xmlelement, mode);
Modified: code/branches/doc/src/libraries/core/ObjectListBase.cc
===================================================================
--- code/branches/doc/src/libraries/core/ObjectListBase.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/core/ObjectListBase.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -69,7 +69,7 @@
/**
@brief Increases all Iterators that currently point on the given element (because it gets removed).
- @param element The element that gets removed
+ @param object The object that gets removed
*/
void ObjectListBase::notifyIterators(OrxonoxClass* object) const
{
@@ -81,7 +81,7 @@
/**
@brief Adds a new object to the end of the list.
- @param object The object to add
+ @param element The element to add
@return The pointer to the new ObjectListBaseElement, needed by the MetaObjectList of the added object
*/
ObjectListBaseElement* ObjectListBase::add(ObjectListBaseElement* element)
Modified: code/branches/doc/src/libraries/core/ObjectListBase.h
===================================================================
--- code/branches/doc/src/libraries/core/ObjectListBase.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/core/ObjectListBase.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -53,7 +53,7 @@
public:
/**
@brief Constructor: Creates the list-element with an object.
- @param object The object to store
+ @param objectBase The object to store
*/
ObjectListBaseElement(OrxonoxClass* objectBase) : next_(0), prev_(0), objectBase_(objectBase) {}
Modified: code/branches/doc/src/libraries/core/ObjectListIterator.h
===================================================================
--- code/branches/doc/src/libraries/core/ObjectListIterator.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/core/ObjectListIterator.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -108,7 +108,7 @@
/**
@brief Assigns the element of another ObjectListIterator.
- @param element The other ObjectListIterator
+ @param other The other ObjectListIterator
*/
inline ObjectListIterator<T>& operator=(const ObjectListIterator<T>& other)
{
Modified: code/branches/doc/src/libraries/core/Resource.h
===================================================================
--- code/branches/doc/src/libraries/core/Resource.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/core/Resource.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -104,14 +104,14 @@
/**
Find out if the named file exists.
- @param filename
+ @param name
Fully qualified name of the file to test for
*/
static bool exists(const std::string& name);
/**
Get struct with information about path and size.
- @param filename
+ @param name
Fully qualified name of the file to test for
*/
static shared_ptr<ResourceInfo> getInfo(const std::string& name);
Modified: code/branches/doc/src/libraries/core/XMLPort.h
===================================================================
--- code/branches/doc/src/libraries/core/XMLPort.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/core/XMLPort.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -147,7 +147,9 @@
@param object The name of the object of the extern class (a member of the main class)
@param paramname The name of the attribute
@param loadfunction The function to set the attribute inside of the member object.
- @param loadfunction The function to get the attribute from the member object
+ @param savefunction The function to get the attribute from the member object
+ @param xmlelement The XML-element that is parsed by this macro
+ @param mode Loading or saving
Sometimes you'll have a member object in your class, which has it's own load- and savefunctions.
With this macro, you can simply use them instead of writing your own functions.
@@ -195,7 +197,7 @@
@param objectclass The baseclass of objects that can be added
@param sectionname The name of the subsection in the XML file that encloses the sub-objects ("" means no subsection)
@param loadfunction The function to add a new object to the class
- @param loadfunction The function to get all added objects from the class
+ @param savefunction The function to get all added objects from the class
@param xmlelement The XMLElement (received through the XMLPort function)
@param mode The mode (load/save) (received through the XMLPort function)
@param bApplyLoaderMask If this is true, an added sub-object gets loaded only if it's class is included in the Loaders ClassTreeMask (this is usually false)
Modified: code/branches/doc/src/libraries/core/command/TclThreadList.h
===================================================================
--- code/branches/doc/src/libraries/core/command/TclThreadList.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/core/command/TclThreadList.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -70,7 +70,7 @@
{ return this->list_; }
/**
- @brief Returns a reference to the mutex which might be useful if you want to iterate through the list (see @ref begin and @ref end).
+ @brief Returns a reference to the mutex which might be useful if you want to iterate through the list (see @ref getList()).
*/
inline boost::shared_mutex& getMutex() const
{ return this->mutex_; }
Modified: code/branches/doc/src/libraries/core/command/TclThreadManager.cc
===================================================================
--- code/branches/doc/src/libraries/core/command/TclThreadManager.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/core/command/TclThreadManager.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -302,7 +302,7 @@
/**
@brief Sends a command to the queue of a given Tcl-interpreter
- @param id The id of the target interpreter
+ @param target_id The id of the target interpreter
@param command The command to be sent
*/
void TclThreadManager::execute(unsigned int target_id, const std::string& command)
@@ -325,6 +325,7 @@
/**
@brief This function can be called from Tcl to send a command to the queue of any interpreter.
@param target_id The id of the target thread
+ @param args Contains the content of the command
*/
void TclThreadManager::tcl_crossexecute(int target_id, const Tcl::object& args)
{
@@ -333,7 +334,7 @@
/**
@brief Sends a command to the queue of a given Tcl-interpreter
- @param id The id of the target interpreter
+ @param target_id The id of the target interpreter
@param command The command to be sent
*/
void TclThreadManager::_execute(unsigned int target_id, const std::string& command)
@@ -346,7 +347,7 @@
/**
@brief Sends a query to a given Tcl-interpreter and waits for the result
- @param id The id of the target interpreter
+ @param target_id The id of the target interpreter
@param command The command to be sent
@return The result of the command
*/
@@ -358,6 +359,7 @@
/**
@brief This function can be called from Tcl to send a query to the main thread.
@param source_id The id of the calling thread
+ @param args Contains the content of the query
A query waits for the result of the command. This means, the calling thread will be blocked until
the main thread answers the query. In return, the main thread sends the result of the console
@@ -372,6 +374,7 @@
@brief This function can be called from Tcl to send a query to another thread.
@param source_id The id of the calling thread
@param target_id The id of the target thread
+ @param args Contains the content of the query
*/
std::string TclThreadManager::tcl_crossquery(int source_id, int target_id, const Tcl::object& args)
{
Modified: code/branches/doc/src/libraries/core/input/InputManager.cc
===================================================================
--- code/branches/doc/src/libraries/core/input/InputManager.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/core/input/InputManager.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -139,10 +139,6 @@
@brief
Creates the OIS::InputMananger, the keyboard, the mouse and
the joys ticks. If either of the first two fail, this method throws an exception.
- @param windowWidth
- The width of the render window
- @param windowHeight
- The height of the render window
*/
void InputManager::loadDevices()
{
Modified: code/branches/doc/src/libraries/core/input/InputManager.h
===================================================================
--- code/branches/doc/src/libraries/core/input/InputManager.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/core/input/InputManager.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -121,6 +121,10 @@
means it gets deleted when the InputManager is destroyed!
@param name
Unique name of the InputState when referenced as string
+ @param bAlwaysGetsInput
+ FIXME - add doc!
+ @param bTransparent
+ FIXME - add doc!
@param priority
Priority matters when multiple states are active. You can specify any
number, but 1 - 99 is preferred (99 means high priority).
Modified: code/branches/doc/src/libraries/core/input/KeyBinder.cc
===================================================================
--- code/branches/doc/src/libraries/core/input/KeyBinder.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/core/input/KeyBinder.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -494,8 +494,12 @@
/**
@brief
Event handler for the mouseMoved Event.
- @param e
- Mouse state information
+ @param abs_
+ The absolute position of the mouse
+ @param rel_
+ The relative movement of the mouse
+ @param clippingSize
+ FIXME - no doc? param not even used?
*/
void KeyBinder::mouseMoved(IntVector2 abs_, IntVector2 rel_, IntVector2 clippingSize)
{
@@ -550,7 +554,8 @@
/**
@brief Event handler for the mouseScrolled Event.
- @param e Mouse state information
+ @param abs The absolute position of the scroll wheel
+ @param rel The relative movement of the scroll wheel
*/
void KeyBinder::mouseScrolled(int abs, int rel)
{
Modified: code/branches/doc/src/libraries/network/ClientInformation.cc
===================================================================
--- code/branches/doc/src/libraries/network/ClientInformation.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/network/ClientInformation.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -229,6 +229,7 @@
* This function goes forward through the list and looks for an element with clientID
* This function should only be applied to the head of the list
* @param clientID id to look for
+ * @param look_backwards FIXME - add doc? parameter unused?
* @return pointer to the last element in the list or 0 if the search was unsuccessfull
*/
ClientInformation *ClientInformation::findClient(unsigned int clientID, bool look_backwards) {
@@ -243,7 +244,8 @@
/**
* This function goes forward through the list and looks for an element with clientID
* This function should only be applied to the head of the list
- * @param peer peer to look for
+ * @param address peer to look for
+ * @param look_backwards FIXME - add doc? parameter unused?
* @return pointer to the element in the list
*/
ClientInformation *ClientInformation::findClient(ENetAddress *address, bool look_backwards) {
Modified: code/branches/doc/src/libraries/network/synchronisable/Synchronisable.cc
===================================================================
--- code/branches/doc/src/libraries/network/synchronisable/Synchronisable.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/network/synchronisable/Synchronisable.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -216,6 +216,7 @@
* |totalsize,objectID_,classID_,var1,var2,string1_length,string1,var3,...|
* length of varx: size saved int syncvarlist
* @param mem pointer to allocated memory with enough size
+ * @param sizes FIXME - add doc!
* @param id gamestateid of the gamestate to be saved (important for priorities)
* @param mode defines the direction in which the data will be send/received
* 0x1: server->client
@@ -287,6 +288,7 @@
* This function takes a bytestream and loads the data into the registered variables
* @param mem pointer to the bytestream
* @param mode same as in getData
+ * @param forceCallback FIXME - add doc!
* @return true/false
*/
bool Synchronisable::updateData(uint8_t*& mem, uint8_t mode, bool forceCallback)
@@ -363,6 +365,7 @@
/**
* This function determines, wheter the object should be saved to the bytestream (according to its syncmode/direction)
* @param id gamestate id
+ * @param mode FIXME - add doc!
* @return true/false
*/
bool Synchronisable::doSync(int32_t id, uint8_t mode)
Modified: code/branches/doc/src/libraries/tools/ResourceCollection.cc
===================================================================
--- code/branches/doc/src/libraries/tools/ResourceCollection.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/tools/ResourceCollection.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -51,10 +51,10 @@
{
}
- void ResourceCollection::XMLPort(Element& xmlElement, XMLPort::Mode mode)
+ void ResourceCollection::XMLPort(Element& xmlelement, XMLPort::Mode mode)
{
- XMLPortParam(ResourceCollection, "resourceGroup", setResourceGroup, getResourceGroup, xmlElement, mode);
- XMLPortObject(ResourceCollection, ResourceLocation, "", addResourceLocation, getResourceLocation, xmlElement, mode);
+ XMLPortParam(ResourceCollection, "resourceGroup", setResourceGroup, getResourceGroup, xmlelement, mode);
+ XMLPortObject(ResourceCollection, ResourceLocation, "", addResourceLocation, getResourceLocation, xmlelement, mode);
}
void ResourceCollection::setResourceGroup(const std::string& resourceGroup)
Modified: code/branches/doc/src/libraries/tools/ResourceCollection.h
===================================================================
--- code/branches/doc/src/libraries/tools/ResourceCollection.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/tools/ResourceCollection.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -43,7 +43,7 @@
ResourceCollection(BaseObject* creator);
virtual ~ResourceCollection();
- virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
+ virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
void setResourceGroup(const std::string& resourceGroup);
const std::string& getResourceGroup() const { return resourceGroup_; }
Modified: code/branches/doc/src/libraries/tools/ResourceLocation.cc
===================================================================
--- code/branches/doc/src/libraries/tools/ResourceLocation.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/tools/ResourceLocation.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -55,11 +55,11 @@
{
}
- void ResourceLocation::XMLPort(Element& xmlElement, XMLPort::Mode mode)
+ void ResourceLocation::XMLPort(Element& xmlelement, XMLPort::Mode mode)
{
- XMLPortParam(ResourceLocation, "path", setPath, getPath, xmlElement, mode);
- XMLPortParam(ResourceLocation, "archiveType", setArchiveType, getArchiveType, xmlElement, mode);
- XMLPortParam(ResourceLocation, "recursive", setRecursive, getRecursive, xmlElement, mode);
+ XMLPortParam(ResourceLocation, "path", setPath, getPath, xmlelement, mode);
+ XMLPortParam(ResourceLocation, "archiveType", setArchiveType, getArchiveType, xmlelement, mode);
+ XMLPortParam(ResourceLocation, "recursive", setRecursive, getRecursive, xmlelement, mode);
if (path_.empty())
ThrowException(AbortLoading, "ResourceLocation: No path given.");
}
Modified: code/branches/doc/src/libraries/tools/ResourceLocation.h
===================================================================
--- code/branches/doc/src/libraries/tools/ResourceLocation.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/tools/ResourceLocation.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -45,7 +45,7 @@
ResourceLocation(BaseObject* creator);
virtual ~ResourceLocation();
- virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
+ virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
void setPath(const std::string& path) { path_ = path; }
const std::string& getPath() const { return path_; }
Modified: code/branches/doc/src/libraries/tools/Timer.cc
===================================================================
--- code/branches/doc/src/libraries/tools/Timer.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/tools/Timer.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -94,7 +94,8 @@
@brief Constructor: Initializes the Timer with given values.
@param interval The timer-interval in seconds
@param bLoop If true, the function gets called every 'interval' seconds
- @param exeuctor A executor of the function to call
+ @param executor A executor of the function to call
+ @param bKillAfterCall If true, the timer will be deleted after the function was executed
*/
Timer::Timer(float interval, bool bLoop, const ExecutorPtr& executor, bool bKillAfterCall)
{
Modified: code/branches/doc/src/libraries/tools/Timer.h
===================================================================
--- code/branches/doc/src/libraries/tools/Timer.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/tools/Timer.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -84,8 +84,8 @@
@brief Initializes the Timer with given values.
@param interval The timer-interval in seconds
@param bLoop If true, the function gets called every 'interval' seconds
- @param object The object owning the timer and the function
@param executor A executor of the function to call
+ @param bKillAfterCall If true, the timer will be deleted after the function was executed
*/
void setTimer(float interval, bool bLoop, const ExecutorPtr& executor, bool bKillAfterCall = false)
{
Modified: code/branches/doc/src/libraries/util/Convert.h
===================================================================
--- code/branches/doc/src/libraries/util/Convert.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/util/Convert.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -277,6 +277,10 @@
Otherwise, the conversion will generate a runtime warning and return false.
For information about the different conversion methods (user defined too), see the section
'Actual conversion sequence' in this file above.
+ @param output
+ A pointer to the variable where the converted value will be stored
+ @param input
+ The original value
*/
template <class FromType, class ToType>
FORCEINLINE bool convertValue(ToType* output, const FromType& input)
@@ -293,6 +297,10 @@
For information about the different conversion methods (user defined too), see the section
'Actual conversion sequence' in this file above.
If the conversion doesn't succeed, 'fallback' is written to '*output'.
+ @param output
+ A pointer to the variable where the converted value will be stored
+ @param input
+ The original value
@param fallback
A default value that gets written to '*output' if there is no conversion.
*/
Modified: code/branches/doc/src/libraries/util/Exception.h
===================================================================
--- code/branches/doc/src/libraries/util/Exception.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/util/Exception.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -59,6 +59,12 @@
Creates the exception but doesn't yet compose the full descrption (because of the virtual functions)
@param description
Exception description as string. This message is supposed to help developers!
+ @param lineNumber
+ The number of the code-line in which the exception occurred
+ @param filename
+ The file in which the exception occurred
+ @param functionName
+ The function in which the exception occurred
*/
Exception(const std::string& description, unsigned int lineNumber,
const char* filename, const char* functionName);
Modified: code/branches/doc/src/libraries/util/OutputHandler.cc
===================================================================
--- code/branches/doc/src/libraries/util/OutputHandler.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/util/OutputHandler.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -66,9 +66,6 @@
/**
@brief
Gets temporary log path and starts the log file
- @param outputHandler
- This is only required to avoid another call to getInstance (this c'tor was
- called from getInstance!)
*/
LogFileWriter()
: OutputListener(OutputHandler::logFileOutputListenerName_s)
@@ -161,9 +158,6 @@
/**
@brief
Sets the right soft debug level and registers itself
- @param outputHandler
- This is only required to avoid another call to getInstance (this c'tor was
- called from getInstance!)
*/
MemoryLogWriter()
: OutputListener("memoryLog")
Modified: code/branches/doc/src/libraries/util/StringUtils.cc
===================================================================
--- code/branches/doc/src/libraries/util/StringUtils.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/util/StringUtils.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -141,7 +141,7 @@
/**
@brief Returns true if the string contains something like '..."between quotes"...'.
- @param The string
+ @param str The string
@return True if there is something between quotes
*/
bool hasStringBetweenQuotes(const std::string& str)
@@ -153,8 +153,7 @@
/**
@brief If the string contains something like '..."between quotes"...' then 'between quotes' gets returned (without quotes).
- @param The string
- @param The string between the quotes
+ @param str The string between the quotes
*/
std::string getStringBetweenQuotes(const std::string& str)
{
@@ -168,7 +167,7 @@
/**
@brief Removes enclosing quotes if available (including whitespaces at the outside of the quotes).
- @brief str The string to strip
+ @param str The string to strip
@return The string with removed quotes
*/
std::string stripEnclosingQuotes(const std::string& str)
Modified: code/branches/doc/src/libraries/util/SubString.cc
===================================================================
--- code/branches/doc/src/libraries/util/SubString.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/util/SubString.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -61,14 +61,19 @@
/**
- * @brief Splits a String into multiple splitters.
- * @param string the String to split
- * @param delimiters multiple set of characters at what to split. (delimiters)
- * @param delimiterNeighbours neighbours of the delimiters, that will be erased only when near a delimiter.
- * @param emptyEntries If empty entries should be allewed or removed.
- * @param escapeChar The Escape Character that overrides splitters commends and so on...
- * @param safemode_char within these characters splitting won't happen
- * @param comment_char the Comment character.
+ * @brief Splits a string into multiple tokens.
+ * @param string The string to split
+ * @param delimiters Multiple set of characters at what to split. (delimiters)
+ * @param delimiterNeighbours Neighbours of the delimiters that will be erased as well.
+ * @param emptyEntries If empty entries are added to the list of SubStrings
+ * @param escapeChar The escape character that overrides splitters commends and so on...
+ * @param removeEscapeChar If true, the escape char is removed from the tokens
+ * @param safemode_char Within these characters splitting won't happen
+ * @param removeSafemodeChar Removes the safemode_char from the beginning and the ending of a token
+ * @param openparenthesis_char The beginning of a safemode is marked with this
+ * @param closeparenthesis_char The ending of a safemode is marked with this
+ * @param removeParenthesisChars Removes the parenthesis from the beginning and the ending of a token
+ * @param comment_char The comment character.
*/
SubString::SubString(const std::string& string,
const std::string& delimiters, const std::string& delimiterNeighbours, bool emptyEntries,
@@ -233,23 +238,28 @@
/**
- * @brief Splits a String into multiple splitters.
- * @param string the String to split
- * @param delimiters multiple set of characters at what to split. (delimiters)
- * @param delimiterNeighbours: Neighbours to the Delimiters that will be erased too.
- * @param emptyEntries: If empty entries are added to the List of SubStrings
- * @param escapeChar The Escape Character that overrides splitters commends and so on...
- * @param safemode_char within these characters splitting won't happen
- * @param comment_char the Comment character.
+ * @brief Splits a string into multiple tokens.
+ * @param string The string to split
+ * @param delimiters Multiple set of characters at what to split. (delimiters)
+ * @param delimiterNeighbours: Neighbours of the delimiters that will be erased too.
+ * @param emptyEntries: If empty entries are added to the list of SubStrings
+ * @param escapeChar The escape character that overrides splitters commends and so on...
+ * @param removeEscapeChar If true, the escape char is removed from the tokens
+ * @param safemode_char Within these characters splitting won't happen
+ * @param removeSafemodeChar Removes the safemode_char from the beginning and the ending of a token
+ * @param openparenthesis_char The beginning of a safemode is marked with this
+ * @param closeparenthesis_char The ending of a safemode is marked with this
+ * @param removeParenthesisChars Removes the parenthesis from the beginning and the ending of a token
+ * @param comment_char The comment character.
*/
unsigned int SubString::split(const std::string& string,
const std::string& delimiters, const std::string& delimiterNeighbours, bool emptyEntries,
- char escapeChar, bool removeExcapeChar, char safemode_char, bool removeSafemodeChar,
+ char escapeChar, bool removeEscapeChar, char safemode_char, bool removeSafemodeChar,
char openparenthesis_char, char closeparenthesis_char, bool removeParenthesisChars, char comment_char)
{
this->strings.clear();
this->bInSafemode.clear();
- SubString::splitLine(this->strings, this->bInSafemode, string, delimiters, delimiterNeighbours, emptyEntries, escapeChar, removeExcapeChar, safemode_char, removeSafemodeChar, openparenthesis_char, closeparenthesis_char, removeParenthesisChars, comment_char);
+ SubString::splitLine(this->strings, this->bInSafemode, string, delimiters, delimiterNeighbours, emptyEntries, escapeChar, removeEscapeChar, safemode_char, removeSafemodeChar, openparenthesis_char, closeparenthesis_char, removeParenthesisChars, comment_char);
return this->strings.size();
}
@@ -303,21 +313,22 @@
/**
- * @brief splits line into tokens and stores them in ret.
- * @param ret the Array, where the Splitted strings will be stored in
- * to the beginning of the current token is stored
- * @param line the inputLine to split
- * @param delimiters a String of Delimiters (here the input will be splitted)
- * @param delimiterNeighbours Neighbours to the Delimiter, that will be removed if they are to the left or the right of a Delimiter.
- * @param emptyEntries: if empty Strings are added to the List of Strings.
- * @param escape_char: Escape carater (escapes splitters)
- * @param safemode_char: the beginning of the safemode is marked with this
- * @param removeSafemodeChar removes the safemode_char from the beginning and the ending of a token
- * @param openparenthesis_char the beginning of a safemode is marked with this
- * @param closeparenthesis_char the ending of a safemode is marked with this
- * @param removeParenthesisChars removes the parenthesis from the beginning and the ending of a token
- * @param comment_char: the beginning of a comment is marked with this: (until the end of a Line)
- * @param start_state: the Initial state on how to parse the String.
+ * @brief Splits a line into tokens and stores them in ret.
+ * @param ret The array, where the splitted strings will be stored in
+ * @param bInSafemode A vector wich stores for each character of the string if it is in safemode or not
+ * @param line The inputLine to split
+ * @param delimiters A string of delimiters (here the input will be splitted)
+ * @param delimiterNeighbours Neighbours of the delimiter, that will be removed if they are to the left or the right of a delimiter.
+ * @param emptyEntries If empty strings are added to the list of strings.
+ * @param escape_char Escape carater (escapes splitters)
+ * @param removeEscapeChar If true, the escape char is removed from the tokens
+ * @param safemode_char The beginning of the safemode is marked with this
+ * @param removeSafemodeChar Removes the safemode_char from the beginning and the ending of a token
+ * @param openparenthesis_char The beginning of a safemode is marked with this
+ * @param closeparenthesis_char The ending of a safemode is marked with this
+ * @param removeParenthesisChars Removes the parenthesis from the beginning and the ending of a token
+ * @param comment_char The beginning of a comment is marked with this: (until the end of a line)
+ * @param start_state The initial state on how to parse the string.
* @return SPLIT_LINE_STATE the parser was in when returning
*
* This is the Actual Splitting Algorithm from Clemens Wacha
@@ -332,7 +343,7 @@
const std::string& delimiterNeighbours,
bool emptyEntries,
char escape_char,
- bool removeExcapeChar,
+ bool removeEscapeChar,
char safemode_char,
bool removeSafemodeChar,
char openparenthesis_char,
@@ -367,7 +378,7 @@
if(line[i] == escape_char)
{
state = SL_ESCAPE;
- if (!removeExcapeChar)
+ if (!removeEscapeChar)
token += line[i];
}
else if(line[i] == safemode_char)
Modified: code/branches/doc/src/libraries/util/SubString.h
===================================================================
--- code/branches/doc/src/libraries/util/SubString.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/libraries/util/SubString.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -114,7 +114,7 @@
unsigned int split(const std::string& string = "", char delimiter = ',');
unsigned int split(const std::string& string,
const std::string& delimiters, const std::string& delimiterNeighbours = "", bool emptyEntries = false,
- char escapeChar ='\\', bool removeExcapeChar = true, char safemode_char = '"', bool removeSafemodeChar = true,
+ char escapeChar ='\\', bool removeEscapeChar = true, char safemode_char = '"', bool removeSafemodeChar = true,
char openparenthesis_char = '{', char closeparenthesis_char = '}', bool removeParenthesisChars = true, char comment_char = '\0');
std::string join(const std::string& delimiter = " ") const;
////////////////////////////////////////
@@ -151,7 +151,7 @@
const std::string& delimiterNeighbours = "",
bool emptyEntries = false,
char escape_char = '\\',
- bool removeExcapeChar = true,
+ bool removeEscapeChar = true,
char safemode_char = '"',
bool removeSafemodeChar = true,
char openparenthesis_char = '{',
Modified: code/branches/doc/src/modules/notifications/Notification.cc
===================================================================
--- code/branches/doc/src/modules/notifications/Notification.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/notifications/Notification.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -54,6 +54,8 @@
/**
@brief
Constructor. Creates a Notification with the input message.
+ @param creator
+ The object that created this Notification
@param message
The message of the Notification.
*/
Modified: code/branches/doc/src/modules/notifications/NotificationQueue.cc
===================================================================
--- code/branches/doc/src/modules/notifications/NotificationQueue.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/notifications/NotificationQueue.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -108,19 +108,19 @@
@brief
Method for creating a NotificationQueue object through XML.
*/
- void NotificationQueue::XMLPort(Element& xmlElement, XMLPort::Mode mode)
+ void NotificationQueue::XMLPort(Element& xmlelement, XMLPort::Mode mode)
{
- SUPER(NotificationQueue, XMLPort, xmlElement, mode);
+ SUPER(NotificationQueue, XMLPort, xmlelement, mode);
this->setDefaults();
- XMLPortParam(NotificationQueue, "maxSize", setMaxSize, getMaxSize, xmlElement, mode);
- XMLPortParam(NotificationQueue, "notificationLength", setNotificationLength, getNotificationLength, xmlElement, mode);
- XMLPortParam(NotificationQueue, "displayTime", setDisplayTime, getDisplayTime, xmlElement, mode);
- XMLPortParam(NotificationQueue, "targets", setTargets, getTargets, xmlElement, mode);
- XMLPortParam(NotificationQueue, "font", setFont, getFont, xmlElement, mode);
- XMLPortParam(NotificationQueue, "fontSize", setFontSize, getFontSize, xmlElement, mode);
- XMLPortParam(NotificationQueue, "position", setPosition, getPosition, xmlElement, mode);
+ XMLPortParam(NotificationQueue, "maxSize", setMaxSize, getMaxSize, xmlelement, mode);
+ XMLPortParam(NotificationQueue, "notificationLength", setNotificationLength, getNotificationLength, xmlelement, mode);
+ XMLPortParam(NotificationQueue, "displayTime", setDisplayTime, getDisplayTime, xmlelement, mode);
+ XMLPortParam(NotificationQueue, "targets", setTargets, getTargets, xmlelement, mode);
+ XMLPortParam(NotificationQueue, "font", setFont, getFont, xmlelement, mode);
+ XMLPortParam(NotificationQueue, "fontSize", setFontSize, getFontSize, xmlelement, mode);
+ XMLPortParam(NotificationQueue, "position", setPosition, getPosition, xmlelement, mode);
COUT(3) << "NotificationQueue '" << this->getName() << "' created." << std::endl;
}
Modified: code/branches/doc/src/modules/notifications/NotificationQueue.h
===================================================================
--- code/branches/doc/src/modules/notifications/NotificationQueue.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/notifications/NotificationQueue.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -92,7 +92,7 @@
NotificationQueue(BaseObject* creator);
virtual ~NotificationQueue();
- virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode); //!< Method for creating a NotificationQueue object through XML.
+ virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a NotificationQueue object through XML.
virtual void tick(float dt); //!< To update from time to time.
Modified: code/branches/doc/src/modules/objects/Planet.cc
===================================================================
--- code/branches/doc/src/modules/objects/Planet.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/objects/Planet.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -143,12 +143,6 @@
this->mesh_.setCastShadows(this->bCastShadows_);
}
- /**
- @brief XML loading and saving.
- @param xmlelement The XML-element
- @param loading Loading (true) or saving (false)
- @return The XML-element
- */
void Planet::XMLPort(Element& xmlelement, XMLPort::Mode mode)
{
SUPER(Planet, XMLPort, xmlelement, mode);
Modified: code/branches/doc/src/modules/objects/triggers/DistanceMultiTrigger.h
===================================================================
--- code/branches/doc/src/modules/objects/triggers/DistanceMultiTrigger.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/objects/triggers/DistanceMultiTrigger.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -64,7 +64,7 @@
/**
@brief Set the target name of DistanceTriggerBeacons that triggers this DistanceMultiTrigger.
- @param targename The name of the DistanceTriggerBeacon as a string.
+ @param targetname The name of the DistanceTriggerBeacon as a string.
*/
inline void setTargetName(const std::string& targetname)
{ if(targetname.compare(BLANKSTRING) != 0) this->singleTargetMode_ = true; else this->singleTargetMode_ = false; this->targetName_ = targetname; }
Modified: code/branches/doc/src/modules/objects/triggers/MultiTrigger.cc
===================================================================
--- code/branches/doc/src/modules/objects/triggers/MultiTrigger.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/objects/triggers/MultiTrigger.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -307,7 +307,7 @@
/**
@brief
Get whether the MultiTrigger is active for a given object.
- @param triggerers
+ @param triggerer
A pointer to the object.
@return
Returns true if the MultiTrigger is active, false if not.
Modified: code/branches/doc/src/modules/overlays/FadeoutText.h
===================================================================
--- code/branches/doc/src/modules/overlays/FadeoutText.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/overlays/FadeoutText.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -43,7 +43,7 @@
FadeoutText(BaseObject* creator);
virtual ~FadeoutText() {}
- virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
+ virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
virtual void tick(float dt);
inline void setDelay(float delay)
Modified: code/branches/doc/src/modules/overlays/GUIOverlay.cc
===================================================================
--- code/branches/doc/src/modules/overlays/GUIOverlay.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/overlays/GUIOverlay.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -51,11 +51,11 @@
{
}
- void GUIOverlay::XMLPort(Element& xmlElement, XMLPort::Mode mode)
+ void GUIOverlay::XMLPort(Element& xmlelement, XMLPort::Mode mode)
{
- SUPER(GUIOverlay, XMLPort, xmlElement, mode);
+ SUPER(GUIOverlay, XMLPort, xmlelement, mode);
- XMLPortParam(GUIOverlay, "guiname", setGUIName, getGUIName, xmlElement, mode);
+ XMLPortParam(GUIOverlay, "guiname", setGUIName, getGUIName, xmlelement, mode);
}
void GUIOverlay::changedVisibility()
Modified: code/branches/doc/src/modules/overlays/GUIOverlay.h
===================================================================
--- code/branches/doc/src/modules/overlays/GUIOverlay.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/overlays/GUIOverlay.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -43,7 +43,7 @@
GUIOverlay(BaseObject* creator);
virtual ~GUIOverlay();
- virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
+ virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
void setGUIName(const std::string& name);
inline const std::string& getGUIName() const { return this->guiName_; }
Modified: code/branches/doc/src/modules/overlays/OverlayText.cc
===================================================================
--- code/branches/doc/src/modules/overlays/OverlayText.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/overlays/OverlayText.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -70,16 +70,16 @@
Ogre::OverlayManager::getSingleton().destroyOverlayElement(this->text_);
}
- void OverlayText::XMLPort(Element& xmlElement, XMLPort::Mode mode)
+ void OverlayText::XMLPort(Element& xmlelement, XMLPort::Mode mode)
{
- SUPER(OverlayText, XMLPort, xmlElement, mode);
+ SUPER(OverlayText, XMLPort, xmlelement, mode);
- XMLPortParam(OverlayText, "font", setFont, getFont, xmlElement, mode);
- XMLPortParam(OverlayText, "colour", setColour, getColour, xmlElement, mode);
- XMLPortParam(OverlayText, "caption", setCaption, getCaption, xmlElement, mode);
- XMLPortParam(OverlayText, "textsize", setTextSize, getTextSize, xmlElement, mode);
- XMLPortParam(OverlayText, "align", setAlignmentString, getAlignmentString, xmlElement, mode);
- XMLPortParam(OverlayText, "spacewidth", setSpaceWidth, getSpaceWidth, xmlElement, mode);
+ XMLPortParam(OverlayText, "font", setFont, getFont, xmlelement, mode);
+ XMLPortParam(OverlayText, "colour", setColour, getColour, xmlelement, mode);
+ XMLPortParam(OverlayText, "caption", setCaption, getCaption, xmlelement, mode);
+ XMLPortParam(OverlayText, "textsize", setTextSize, getTextSize, xmlelement, mode);
+ XMLPortParam(OverlayText, "align", setAlignmentString, getAlignmentString, xmlelement, mode);
+ XMLPortParam(OverlayText, "spacewidth", setSpaceWidth, getSpaceWidth, xmlelement, mode);
}
void OverlayText::setAlignmentString(const std::string& alignment)
Modified: code/branches/doc/src/modules/overlays/OverlayText.h
===================================================================
--- code/branches/doc/src/modules/overlays/OverlayText.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/overlays/OverlayText.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -51,7 +51,7 @@
OverlayText(BaseObject* creator);
virtual ~OverlayText();
- virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
+ virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
void setCaption(const std::string& caption);
std::string getCaption() const;
Modified: code/branches/doc/src/modules/overlays/hud/HUDBar.cc
===================================================================
--- code/branches/doc/src/modules/overlays/hud/HUDBar.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/overlays/hud/HUDBar.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -54,12 +54,12 @@
this->setPosition(0.0);
}
- void BarColour::XMLPort(Element& xmlElement, XMLPort::Mode mode)
+ void BarColour::XMLPort(Element& xmlelement, XMLPort::Mode mode)
{
- SUPER(BarColour, XMLPort, xmlElement, mode);
+ SUPER(BarColour, XMLPort, xmlelement, mode);
- XMLPortParam(BarColour, "colour", setColour, getColour, xmlElement, mode);
- XMLPortParam(BarColour, "position", setPosition, getPosition, xmlElement, mode);
+ XMLPortParam(BarColour, "colour", setColour, getColour, xmlelement, mode);
+ XMLPortParam(BarColour, "position", setPosition, getPosition, xmlelement, mode);
}
@@ -103,15 +103,15 @@
}
}
- void HUDBar::XMLPort(Element& xmlElement, XMLPort::Mode mode)
+ void HUDBar::XMLPort(Element& xmlelement, XMLPort::Mode mode)
{
- SUPER(HUDBar, XMLPort, xmlElement, mode);
+ SUPER(HUDBar, XMLPort, xmlelement, mode);
- XMLPortParam(HUDBar, "initialvalue", setValue, getValue, xmlElement, mode);
- XMLPortParam(HUDBar, "righttoleft", setRightToLeft, getRightToLeft, xmlElement, mode);
- XMLPortParam(HUDBar, "autocolour", setAutoColour, getAutoColour, xmlElement, mode);
- XMLPortParam(HUDBar, "bartexture", setBarTexture, getBarTexture, xmlElement, mode);
- XMLPortObject(HUDBar, BarColour, "", addColour, getColour, xmlElement, mode);
+ XMLPortParam(HUDBar, "initialvalue", setValue, getValue, xmlelement, mode);
+ XMLPortParam(HUDBar, "righttoleft", setRightToLeft, getRightToLeft, xmlelement, mode);
+ XMLPortParam(HUDBar, "autocolour", setAutoColour, getAutoColour, xmlelement, mode);
+ XMLPortParam(HUDBar, "bartexture", setBarTexture, getBarTexture, xmlelement, mode);
+ XMLPortObject(HUDBar, BarColour, "", addColour, getColour, xmlelement, mode);
}
void HUDBar::valueChanged()
Modified: code/branches/doc/src/modules/overlays/hud/HUDBar.h
===================================================================
--- code/branches/doc/src/modules/overlays/hud/HUDBar.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/overlays/hud/HUDBar.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -49,7 +49,7 @@
BarColour(BaseObject* creator);
virtual ~BarColour() { }
- virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
+ virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
void setColour(const ColourValue& colour) { this->colour_ = colour; }
const ColourValue& getColour() const { return this->colour_; }
@@ -69,7 +69,7 @@
HUDBar(BaseObject* creator);
virtual ~HUDBar();
- virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
+ virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
void clearColours();
Modified: code/branches/doc/src/modules/overlays/hud/HUDHealthBar.h
===================================================================
--- code/branches/doc/src/modules/overlays/hud/HUDHealthBar.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/overlays/hud/HUDHealthBar.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -44,7 +44,7 @@
HUDHealthBar(BaseObject* creator);
virtual ~HUDHealthBar();
- virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
+ virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
virtual void tick(float dt);
virtual void changedOwner();
virtual void changedOverlayGroup();
Modified: code/branches/doc/src/modules/overlays/hud/HUDNavigation.cc
===================================================================
--- code/branches/doc/src/modules/overlays/hud/HUDNavigation.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/overlays/hud/HUDNavigation.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -89,13 +89,13 @@
sortedObjectList_.clear();
}
-void HUDNavigation::XMLPort ( Element& xmlElement, XMLPort::Mode mode )
+void HUDNavigation::XMLPort ( Element& xmlelement, XMLPort::Mode mode )
{
- SUPER ( HUDNavigation, XMLPort, xmlElement, mode );
+ SUPER ( HUDNavigation, XMLPort, xmlelement, mode );
- XMLPortParam ( HUDNavigation, "font", setFont, getFont, xmlElement, mode );
- XMLPortParam ( HUDNavigation, "textSize", setTextSize, getTextSize, xmlElement, mode );
- XMLPortParam ( HUDNavigation, "navMarkerSize", setNavMarkerSize, getNavMarkerSize, xmlElement, mode );
+ XMLPortParam ( HUDNavigation, "font", setFont, getFont, xmlelement, mode );
+ XMLPortParam ( HUDNavigation, "textSize", setTextSize, getTextSize, xmlelement, mode );
+ XMLPortParam ( HUDNavigation, "navMarkerSize", setNavMarkerSize, getNavMarkerSize, xmlelement, mode );
}
void HUDNavigation::setFont ( const std::string& font )
Modified: code/branches/doc/src/modules/overlays/hud/HUDNavigation.h
===================================================================
--- code/branches/doc/src/modules/overlays/hud/HUDNavigation.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/overlays/hud/HUDNavigation.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -50,7 +50,7 @@
void setConfigValues();
- virtual void XMLPort ( Element& xmlElement, XMLPort::Mode mode );
+ virtual void XMLPort ( Element& xmlelement, XMLPort::Mode mode );
virtual void tick ( float dt );
virtual void addObject ( RadarViewable* object );
Modified: code/branches/doc/src/modules/overlays/hud/HUDRadar.cc
===================================================================
--- code/branches/doc/src/modules/overlays/hud/HUDRadar.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/overlays/hud/HUDRadar.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -81,13 +81,13 @@
}
}
- void HUDRadar::XMLPort(Element& xmlElement, XMLPort::Mode mode)
+ void HUDRadar::XMLPort(Element& xmlelement, XMLPort::Mode mode)
{
- SUPER(HUDRadar, XMLPort, xmlElement, mode);
+ SUPER(HUDRadar, XMLPort, xmlelement, mode);
- XMLPortParam(HUDRadar, "sensitivity", setRadarSensitivity, getRadarSensitivity, xmlElement, mode);
- XMLPortParam(HUDRadar, "halfDotSizeDistance", setHalfDotSizeDistance, getHalfDotSizeDistance, xmlElement, mode);
- XMLPortParam(HUDRadar, "maximumDotSize", setMaximumDotSize, getMaximumDotSize, xmlElement, mode);
+ XMLPortParam(HUDRadar, "sensitivity", setRadarSensitivity, getRadarSensitivity, xmlelement, mode);
+ XMLPortParam(HUDRadar, "halfDotSizeDistance", setHalfDotSizeDistance, getHalfDotSizeDistance, xmlelement, mode);
+ XMLPortParam(HUDRadar, "maximumDotSize", setMaximumDotSize, getMaximumDotSize, xmlelement, mode);
}
void HUDRadar::addObject(RadarViewable* object)
Modified: code/branches/doc/src/modules/overlays/hud/HUDRadar.h
===================================================================
--- code/branches/doc/src/modules/overlays/hud/HUDRadar.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/overlays/hud/HUDRadar.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -48,7 +48,7 @@
HUDRadar(BaseObject* creator);
virtual ~HUDRadar();
- virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
+ virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
virtual void changedOwner();
private:
Modified: code/branches/doc/src/modules/overlays/stats/Scoreboard.cc
===================================================================
--- code/branches/doc/src/modules/overlays/stats/Scoreboard.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/overlays/stats/Scoreboard.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -55,14 +55,6 @@
}
}
- /**
- @brief Initializes the lines.
- */
- void Scoreboard::XMLPort(Element& xmlElement, XMLPort::Mode mode)
- {
- SUPER(Scoreboard, XMLPort, xmlElement, mode);
- }
-
void Scoreboard::changedVisibility()
{
SUPER(Scoreboard, changedVisibility);
Modified: code/branches/doc/src/modules/overlays/stats/Scoreboard.h
===================================================================
--- code/branches/doc/src/modules/overlays/stats/Scoreboard.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/overlays/stats/Scoreboard.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -43,7 +43,6 @@
Scoreboard(BaseObject* creator);
virtual ~Scoreboard();
- virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
virtual void tick(float dt);
inline void setCreateLines(CreateLines* cl)
Modified: code/branches/doc/src/modules/overlays/stats/Stats.cc
===================================================================
--- code/branches/doc/src/modules/overlays/stats/Stats.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/overlays/stats/Stats.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -97,14 +97,6 @@
SetConfigValue(noiseSize_, 1.0f);
}
- /**
- @brief Initializes the Stats panel.
- */
- void Stats::XMLPort(Element& xmlElement, XMLPort::Mode mode)
- {
- OrxonoxOverlay::XMLPort(xmlElement, mode);
- }
-
void Stats::tick(float dt)
{
// SUPER(Stats, tick, dt);
Modified: code/branches/doc/src/modules/overlays/stats/Stats.h
===================================================================
--- code/branches/doc/src/modules/overlays/stats/Stats.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/overlays/stats/Stats.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -45,8 +45,6 @@
void setConfigValues();
- virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
-
virtual void tick(float dt);
private: // variables
Modified: code/branches/doc/src/modules/pickup/DroppedPickup.cc
===================================================================
--- code/branches/doc/src/modules/pickup/DroppedPickup.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/pickup/DroppedPickup.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -60,8 +60,8 @@
The creator of the DroppedPickup.
@param pickup
The Pickupable that was dropped.
- @param position
- The position at which the DroppedPickup should be created.
+ @param carrier
+ FIXME - add doc!
@param triggerDistance
The distance at which the PickupSpawner triggers. Default is 10.
*/
Modified: code/branches/doc/src/modules/pickup/Pickup.cc
===================================================================
--- code/branches/doc/src/modules/pickup/Pickup.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/pickup/Pickup.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -224,8 +224,6 @@
Facilitates the creation of a PickupSpawner upon dropping of the Pickupable.
This method must be implemented by any class directly inheriting from Pickupable. It is most easily done by just creating a new DroppedPickup, e.g.:
DroppedPickup(BaseObject* creator, Pickupable* pickup, const Vector3& position);
- @param position
- The position at which the PickupSpawner should be placed.
@return
Returns true if a spawner was created, false if not.
*/
Modified: code/branches/doc/src/modules/pickup/PickupCollection.cc
===================================================================
--- code/branches/doc/src/modules/pickup/PickupCollection.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/pickup/PickupCollection.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -227,8 +227,8 @@
/**
@brief
Get whether a given class, represented by the input Identifier, is a target of this PickupCollection.
- @param identifier
- A pointer to the PickupIdentifier of the PickupCarrier we want to know of, whether it is a target of this PickupCollection.
+ @param carrier
+ A pointer to the PickupCarrier we want to know of, whether it is a target of this PickupCollection.
@return
Returns true if the PickupCarrier identified by the input PickupIdentififer it is a target of this PickupCollection, false if not.
*/
@@ -335,8 +335,6 @@
Facilitates the creation of a PickupSpawner upon dropping of the Pickupable.
This method must be implemented by any class directly inheriting from Pickupable. It is most easily done by just creating a new DroppedPickup, e.g.:
DroppedPickup(BaseObject* creator, Pickupable* pickup, const Vector3& position);
- @param position
- The position at which the PickupSpawner should be placed.
@return
Returns true if a spawner was created, false if not.
*/
Modified: code/branches/doc/src/modules/pickup/PickupCollectionIdentifier.cc
===================================================================
--- code/branches/doc/src/modules/pickup/PickupCollectionIdentifier.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/pickup/PickupCollectionIdentifier.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -98,7 +98,7 @@
/**
@brief
Add a Pickupable to the PickupCollectionIdentifier.
- @param
+ @param identifier
A pointer to the PickupIdentifier of the Pickupable to be added.
*/
void PickupCollectionIdentifier::addPickup(const PickupIdentifier* identifier)
Modified: code/branches/doc/src/modules/pickup/PickupSpawner.cc
===================================================================
--- code/branches/doc/src/modules/pickup/PickupSpawner.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/pickup/PickupSpawner.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -69,7 +69,7 @@
The distance at which the PickupSpawner will trigger.
@param respawnTime
The minimum time between two spawns.
- @param maySpawnedItems
+ @param maxSpawnedItems
The maximum number of items spawned by this PickupSpawner.
*/
PickupSpawner::PickupSpawner(BaseObject* creator, Pickupable* pickup, float triggerDistance, float respawnTime, int maxSpawnedItems) : StaticEntity(creator), pickup_(NULL)
Modified: code/branches/doc/src/modules/pickup/items/SpeedPickup.cc
===================================================================
--- code/branches/doc/src/modules/pickup/items/SpeedPickup.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/pickup/items/SpeedPickup.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -251,7 +251,7 @@
/**
@brief
Sets the SpeedMultiply
- @param speedAdd
+ @param speedMultiply
The multiplied Speed
*/
void SpeedPickup::setSpeedMultiply(float speedMultiply)
Modified: code/branches/doc/src/modules/questsystem/AddQuestHint.cc
===================================================================
--- code/branches/doc/src/modules/questsystem/AddQuestHint.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/questsystem/AddQuestHint.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -79,7 +79,7 @@
Sets the id of the QuestHint to be added to the player the QuestEffect is invoked on.
@param id
The QuestHint id.
- @param
+ @return
Returns true if successful.
*/
bool AddQuestHint::setHintId(const std::string & id)
Modified: code/branches/doc/src/modules/questsystem/Quest.cc
===================================================================
--- code/branches/doc/src/modules/questsystem/Quest.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/questsystem/Quest.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -196,7 +196,7 @@
/**
@brief
Returns the subquest at the given index.
- @param
+ @param index
The index.
@return
Returns a pointer to the subquest at the given index. NULL if there is no element at the given index.
@@ -221,7 +221,7 @@
/**
@brief
Returns the QuestHint at the given index.
- @param
+ @param index
The index.
@return
Returns a pointer to the QuestHint at the given index. NULL if there is no element at the given index.
@@ -245,7 +245,7 @@
/**
@brief
Returns the fail QuestEffect at the given index.
- @param
+ @param index
The index.
@return
Returns a pointer to the fail QuestEffect at the given index. NULL if there is no element at the given index.
@@ -269,7 +269,7 @@
/**
@brief
Returns the complete QuestEffect at the given index.
- @param
+ @param index
The index.
@return
Returns a pointer to the complete QuestEffect at the given index. NULL if there is no element at the given index.
Modified: code/branches/doc/src/modules/questsystem/QuestEffectBeacon.cc
===================================================================
--- code/branches/doc/src/modules/questsystem/QuestEffectBeacon.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/questsystem/QuestEffectBeacon.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -91,6 +91,8 @@
@brief
Executes the QuestEffectBeacon.
This means extracting the Pawn from the PlayerTrigger, provided by the Event causing the execution, and the extracting the PlayerInfo from the received Pawn and invoking the QuestEffectbeacon's QuestEffects on the received PlayerInfo.
+ @param b
+ true means the trigger was activated while false means it was deactivated
@param trigger
A pointer to the PlayerTrigger that threw the Event.
@return
Modified: code/branches/doc/src/modules/questsystem/QuestNotification.cc
===================================================================
--- code/branches/doc/src/modules/questsystem/QuestNotification.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/modules/questsystem/QuestNotification.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -47,6 +47,8 @@
/**
@brief
Creates a QuestNotification with the input message.
+ @param creator
+ The creator of this object
@param message
The message to be sent.
*/
Modified: code/branches/doc/src/orxonox/controllers/ArtificialController.cc
===================================================================
--- code/branches/doc/src/orxonox/controllers/ArtificialController.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/orxonox/controllers/ArtificialController.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -664,7 +664,7 @@
/**
@brief Master begins to follow a pawn. Is a "specific master action".
@param pawn pawn to follow.
- @param alaways follows pawn forever if true (false if omitted).
+ @param always follows pawn forever if true (false if omitted).
@param secondsToFollow seconds to follow the pawn if always is false. Will follow pawn 100 seconds if omitted (set in header).
*/
void ArtificialController::followInit(Pawn* pawn, const bool always, const int secondsToFollow)
Modified: code/branches/doc/src/orxonox/graphics/Light.h
===================================================================
--- code/branches/doc/src/orxonox/graphics/Light.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/orxonox/graphics/Light.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -82,11 +82,12 @@
/**
@brief Sets the attenuation parameters of the light source i.e. how it diminishes with distance.
+ @param attenuation The parameters of the attenuation (see description)
- @param attenuation.x range (The absolute upper range of the light in world units)
- @param attenuation.y constant (The constant factor in the attenuation formula: 1.0 means never attenuate, 0.0 is complete attenuation)
- @param attenuation.z linear (The linear factor in the attenuation formula: 1 means attenuate evenly over the distance)
- @param attenuation.w quadratic (The quadratic factor in the attenuation formula: adds a curvature to the attenuation formula)
+ - @a attenuation.x range (The absolute upper range of the light in world units)
+ - @a attenuation.y constant (The constant factor in the attenuation formula: 1.0 means never attenuate, 0.0 is complete attenuation)
+ - @a attenuation.z linear (The linear factor in the attenuation formula: 1 means attenuate evenly over the distance)
+ - @a attenuation.w quadratic (The quadratic factor in the attenuation formula: adds a curvature to the attenuation formula)
Quote from the Ogre API:
Lights normally get fainter the further they are away. Also, each light is given a maximum range beyond which it cannot affect any objects.
@@ -119,10 +120,11 @@
/**
@brief Sets the range of a spotlight, i.e. the angle of the inner and outer cones and the rate of falloff between them.
-
- @param spotlightRange.x innerAngle (The angle covered by the bright inner cone)
- @param spotlightRange.x outerAngle (The angle covered by the outer cone)
- @param spotlightRange.x falloff (The rate of falloff between the inner and outer cones. 1.0 means a linear falloff, less means slower falloff, higher means faster falloff.)
+ @param spotlightRange The parameters of the spotlight (see description)
+
+ - @a spotlightRange.x innerAngle (The angle covered by the bright inner cone)
+ - @a spotlightRange.x outerAngle (The angle covered by the outer cone)
+ - @a spotlightRange.x falloff (The rate of falloff between the inner and outer cones. 1.0 means a linear falloff, less means slower falloff, higher means faster falloff.)
*/
inline void setSpotlightRange(const Vector3& spotlightRange)
{ this->spotlightRange_ = spotlightRange; this->updateSpotlightRange(); }
Modified: code/branches/doc/src/orxonox/interfaces/Pickupable.h
===================================================================
--- code/branches/doc/src/orxonox/interfaces/Pickupable.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/orxonox/interfaces/Pickupable.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -161,7 +161,6 @@
@brief Facilitates the creation of a PickupSpawner upon dropping of the Pickupable.
This method must be implemented by any class directly inheriting from Pickupable. It is most easily done by just creating a new DroppedPickup, e.g.:
DroppedPickup(BaseObject* creator, Pickupable* pickup, PickupCarrier* carrier, float triggerDistance);
- @param position The position at which the PickupSpawner should be placed.
@return Returns true if a spawner was created, false if not.
*/
virtual bool createSpawner(void) = 0;
Modified: code/branches/doc/src/orxonox/overlays/GUISheet.cc
===================================================================
--- code/branches/doc/src/orxonox/overlays/GUISheet.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/orxonox/overlays/GUISheet.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -53,14 +53,14 @@
{
}
- void GUISheet::XMLPort(Element& xmlElement, XMLPort::Mode mode)
+ void GUISheet::XMLPort(Element& xmlelement, XMLPort::Mode mode)
{
- SUPER(GUISheet, XMLPort, xmlElement, mode);
+ SUPER(GUISheet, XMLPort, xmlelement, mode);
- XMLPortParam(GUISheet, "showOnLoad", setShowOnLoad, getShowOnLoad, xmlElement, mode);
- XMLPortParam(GUISheet, "hidePrevious", setPreviousHiding, getPreviousHiding, xmlElement, mode);
- XMLPortParam(GUISheet, "sheetName", setSheetName, getSheetName, xmlElement, mode);
- XMLPortParam(GUISheet, "backgroundImage", setBackgroundImage, getBackgroundImage, xmlElement, mode);
+ XMLPortParam(GUISheet, "showOnLoad", setShowOnLoad, getShowOnLoad, xmlelement, mode);
+ XMLPortParam(GUISheet, "hidePrevious", setPreviousHiding, getPreviousHiding, xmlelement, mode);
+ XMLPortParam(GUISheet, "sheetName", setSheetName, getSheetName, xmlelement, mode);
+ XMLPortParam(GUISheet, "backgroundImage", setBackgroundImage, getBackgroundImage, xmlelement, mode);
if (this->bShowOnLoad_)
this->show();
Modified: code/branches/doc/src/orxonox/overlays/GUISheet.h
===================================================================
--- code/branches/doc/src/orxonox/overlays/GUISheet.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/orxonox/overlays/GUISheet.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -43,7 +43,7 @@
GUISheet(BaseObject* creator);
~GUISheet();
- void XMLPort(Element& xmlElement, XMLPort::Mode mode);
+ void XMLPort(Element& xmlelement, XMLPort::Mode mode);
void show();
void hide();
Modified: code/branches/doc/src/orxonox/overlays/InGameConsole.cc
===================================================================
--- code/branches/doc/src/orxonox/overlays/InGameConsole.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/orxonox/overlays/InGameConsole.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -453,7 +453,10 @@
/**
@brief Prints string to bottom line.
- @param s String to be printed
+ @param text The string to be printed
+ @param type The type of the text, defines the color
+ @param index The index of the text overlay in which the string will be displayed
+ @param alwaysShift If true the ohter lines in the console are always shifted by one line
*/
void InGameConsole::print(const std::string& text, Shell::LineType type, int index, bool alwaysShift)
{
Modified: code/branches/doc/src/orxonox/overlays/OrxonoxOverlay.cc
===================================================================
--- code/branches/doc/src/orxonox/overlays/OrxonoxOverlay.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/orxonox/overlays/OrxonoxOverlay.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -125,16 +125,16 @@
@copydoc
BaseObject::XMLPort()
*/
- void OrxonoxOverlay::XMLPort(Element& xmlElement, XMLPort::Mode mode)
+ void OrxonoxOverlay::XMLPort(Element& xmlelement, XMLPort::Mode mode)
{
- SUPER(OrxonoxOverlay, XMLPort, xmlElement, mode);
+ SUPER(OrxonoxOverlay, XMLPort, xmlelement, mode);
- XMLPortParam(OrxonoxOverlay, "size", setSize, getSize, xmlElement, mode);
- XMLPortParam(OrxonoxOverlay, "pickpoint", setPickPoint, getPickPoint, xmlElement, mode);
- XMLPortParam(OrxonoxOverlay, "position", setPosition, getPosition, xmlElement, mode);
- XMLPortParam(OrxonoxOverlay, "rotation", setRotation, getRotation, xmlElement, mode);
- XMLPortParam(OrxonoxOverlay, "correctaspect", setAspectCorrection, getAspectCorrection, xmlElement, mode);
- XMLPortParam(OrxonoxOverlay, "background", setBackgroundMaterial, getBackgroundMaterial, xmlElement, mode);
+ XMLPortParam(OrxonoxOverlay, "size", setSize, getSize, xmlelement, mode);
+ XMLPortParam(OrxonoxOverlay, "pickpoint", setPickPoint, getPickPoint, xmlelement, mode);
+ XMLPortParam(OrxonoxOverlay, "position", setPosition, getPosition, xmlelement, mode);
+ XMLPortParam(OrxonoxOverlay, "rotation", setRotation, getRotation, xmlelement, mode);
+ XMLPortParam(OrxonoxOverlay, "correctaspect", setAspectCorrection, getAspectCorrection, xmlelement, mode);
+ XMLPortParam(OrxonoxOverlay, "background", setBackgroundMaterial, getBackgroundMaterial, xmlelement, mode);
}
void OrxonoxOverlay::changedName()
@@ -305,6 +305,8 @@
@param name
The name of the overlay defined BaseObject::setName() (usually done with the "name"
attribute in the xml file).
+ @param scale
+ The scaling factor
*/
/*static*/ void OrxonoxOverlay::scaleOverlay(const std::string& name, float scale)
{
@@ -345,6 +347,8 @@
@param name
The name of the overlay defined BaseObject::setName() (usually done with the "name"
attribute in the xml file).
+ @param scroll
+ The relative translation of the overlay
*/
/*static*/ void OrxonoxOverlay::scrollOverlay(const std::string& name, const Vector2& scroll)
{
@@ -359,6 +363,8 @@
@param name
The name of the overlay defined BaseObject::setName() (usually done with the "name"
attribute in the xml file).
+ @param angle
+ The rotation angle in degree
*/
/*static*/ void OrxonoxOverlay::rotateOverlay(const std::string& name, const Degree& angle)
{
Modified: code/branches/doc/src/orxonox/overlays/OrxonoxOverlay.h
===================================================================
--- code/branches/doc/src/orxonox/overlays/OrxonoxOverlay.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/orxonox/overlays/OrxonoxOverlay.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -89,7 +89,7 @@
OrxonoxOverlay(BaseObject* creator);
virtual ~OrxonoxOverlay();
- virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
+ virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
virtual void changedName();
Modified: code/branches/doc/src/orxonox/overlays/OverlayGroup.cc
===================================================================
--- code/branches/doc/src/orxonox/overlays/OverlayGroup.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/orxonox/overlays/OverlayGroup.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -70,14 +70,14 @@
@copydoc
BaseObject::XMLPort()
*/
- void OverlayGroup::XMLPort(Element& xmlElement, XMLPort::Mode mode)
+ void OverlayGroup::XMLPort(Element& xmlelement, XMLPort::Mode mode)
{
- SUPER(OverlayGroup, XMLPort, xmlElement, mode);
+ SUPER(OverlayGroup, XMLPort, xmlelement, mode);
- XMLPortParam(OverlayGroup, "scale", setScale, getScale, xmlElement, mode);
- XMLPortParam(OverlayGroup, "scroll", setScroll, getScroll, xmlElement, mode);
+ XMLPortParam(OverlayGroup, "scale", setScale, getScale, xmlelement, mode);
+ XMLPortParam(OverlayGroup, "scroll", setScroll, getScroll, xmlelement, mode);
// loads all the child elements
- XMLPortObject(OverlayGroup, OrxonoxOverlay, "", addElement, getElement, xmlElement, mode);
+ XMLPortObject(OverlayGroup, OrxonoxOverlay, "", addElement, getElement, xmlelement, mode);
}
//! Scales every element in the set.
@@ -113,8 +113,8 @@
/**
@brief
Removes an element from the map.
- @param name
- The name of the element that is removed.
+ @param element
+ A pointer to the element that is removed.
@return
Returns true if there was such an element to remove, false if not.
*/
@@ -180,6 +180,8 @@
@param name
The name of the group defined BaseObject::setName() (usually done with the "name"
attribute in the xml file).
+ @param scale
+ The scaling factor
*/
/*static*/ void OverlayGroup::scaleGroup(const std::string& name, float scale)
{
@@ -196,6 +198,8 @@
@param name
The name of the group defined BaseObject::setName() (usually done with the "name"
attribute in the xml file).
+ @param scroll
+ The relative translation of the overlay group
*/
/*static*/ void OverlayGroup::scrollGroup(const std::string& name, const Vector2& scroll)
{
Modified: code/branches/doc/src/orxonox/overlays/OverlayGroup.h
===================================================================
--- code/branches/doc/src/orxonox/overlays/OverlayGroup.h 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/orxonox/overlays/OverlayGroup.h 2010-08-31 18:37:29 UTC (rev 7297)
@@ -57,7 +57,7 @@
//! Empty destructor.
~OverlayGroup();
- virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
+ virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
static void toggleVisibility(const std::string& name);
static void scaleGroup(const std::string& name, float scale);
Modified: code/branches/doc/src/orxonox/worldentities/WorldEntity.cc
===================================================================
--- code/branches/doc/src/orxonox/worldentities/WorldEntity.cc 2010-08-31 16:43:34 UTC (rev 7296)
+++ code/branches/doc/src/orxonox/worldentities/WorldEntity.cc 2010-08-31 18:37:29 UTC (rev 7297)
@@ -649,8 +649,10 @@
/**
@brief
Translates this WorldEntity by a vector.
+ @param distance
+ The relative distance of the translation
@param relativeTo
- @see WorldEntity::TransformSpace
+ The TransformSpace of this translation
*/
void WorldEntity::translate(const Vector3& distance, TransformSpace relativeTo)
{
@@ -677,8 +679,10 @@
/**
@brief
Rotates this WorldEntity by a quaternion.
+ @param rotation
+ The desired relative rotation
@param relativeTo
- @see WorldEntity::TransformSpace
+ The TransformSpace of this translation
*/
void WorldEntity::rotate(const Quaternion& rotation, TransformSpace relativeTo)
{
@@ -702,8 +706,10 @@
/**
@brief
Makes this WorldEntity look at a specific target location.
+ @param target
+ An absolute point in the space which defines the direction of the entity
@param relativeTo
- @see WorldEntity::TransformSpace
+ The TransformSpace of this translation
@param localDirectionVector
The vector which normally describes the natural direction of the object, usually -Z.
*/
@@ -728,8 +734,10 @@
/**
@brief
Makes this WorldEntity look in specific direction.
+ @param direction
+ A point relative to the position of the WorldEntity which defines its orientation
@param relativeTo
- @see WorldEntity::TransformSpace
+ The TransformSpace of this translation
@param localDirectionVector
The vector which normally describes the natural direction of the object, usually -Z.
*/
@@ -772,7 +780,7 @@
/**
@brief
- Sets the CollisionType. This alters the object significantly! @see CollisionType.
+ Sets the CollisionType. This alters the object significantly!
@note
Operation does not work on attached WorldEntities.
*/
More information about the Orxonox-commit
mailing list