Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 7297


Ignore:
Timestamp:
Aug 31, 2010, 8:37:29 PM (9 years ago)
Author:
landauf
Message:

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.

Location:
code/branches/doc/src
Files:
77 edited

Legend:

Unmodified
Added
Removed
  • code/branches/doc/src/libraries/core/BaseObject.cc

    r7284 r7297  
    116116        @brief XML loading and saving.
    117117        @param xmlelement The XML-element
    118         @param loading Loading (true) or saving (false)
     118        @param mode The mode defines the operation that is being executed: loading or saving the object (from or to XML respectively)
    119119    */
    120120    void BaseObject::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     
    141141        @brief Defines the possible event states of this object and parses eventsources from an XML file.
    142142        @param xmlelement The XML-element
    143         @param loading Loading (true) or saving (false)
     143        @param mode The mode defines the operation that is being executed: loading or saving the object (from or to XML respectively)
    144144    */
    145145    void BaseObject::XMLEventPort(Element& xmlelement, XMLPort::Mode mode)
  • code/branches/doc/src/libraries/core/CommandLineParser.cc

    r7284 r7297  
    126126    @param arguments
    127127        Vector of space separated strings.
     128    @param bParsingFile
     129        FIXME - add doc!
    128130    */
    129131    void CommandLineParser::_parse(const std::vector<std::string>& arguments, bool bParsingFile)
     
    244246    @param value
    245247        String containing the value
     248    @param bParsingFile
     249        FIXME - add doc!
    246250    */
    247251    void CommandLineParser::checkFullArgument(const std::string& name, const std::string& value, bool bParsingFile)
     
    261265    @param value
    262266        String containing the value
     267    @param bParsingFile
     268        FIXME - add doc!
    263269    */
    264270    void CommandLineParser::checkShortcut(const std::string& shortcut, const std::string& value, bool bParsingFile)
  • code/branches/doc/src/libraries/core/CommandLineParser.h

    r7284 r7297  
    207207    @param defaultValue
    208208        Default value that is used when argument was not given.
     209    @param bCommandLineOnly
     210        FIXME - add doc!
    209211    */
    210212    template <class T>
  • code/branches/doc/src/libraries/core/ConfigValueContainer.h

    r6536 r7297  
    117117                @param type The type of the corresponding config-file
    118118                @param identifier The identifier of the class the variable belongs to
     119                @param sectionname Name of the section the configValue should be put in.
    119120                @param varname The name of the variable
    120121                @param defvalue The default-value
     122                @param value Only needed do determine the right type.
    121123            */
    122124            template <class D, class V>
  • code/branches/doc/src/libraries/core/CoreIncludes.h

    r6423 r7297  
    101101    /**
    102102        @brief Returns the Identifier with a given name.
    103         @param String The name of the class
     103        @param name The name of the class
    104104    */
    105105    inline Identifier* ClassByString(const std::string& name)
     
    110110    /**
    111111        @brief Returns the Identifier with a given lowercase name.
    112         @param String The lowercase name of the class
     112        @param name The lowercase name of the class
    113113    */
    114114    inline Identifier* ClassByLowercaseString(const std::string& name)
     
    119119    /**
    120120        @brief Returns the Identifier with a given network ID.
    121         @param networkID The network ID of the class
     121        @param id The network ID of the class
    122122    */
    123123    inline Identifier* ClassByID(uint32_t id)
     
    130130        @note This of course only works with OrxonoxClasses.
    131131              The only use is in conjunction with macros that don't know the class type.
    132         @param Pointer to an OrxonoxClass
     132        @param object Pointer to an OrxonoxClass
    133133    */
    134134    template <class T>
  • code/branches/doc/src/libraries/core/DynLibManager.h

    r5738 r7297  
    5656
    5757        public:
    58             /** Default constructor.
    59                 @note
    60                     <br>Should never be called as the singleton is automatically
    61                     created during the creation of the Root object.
    62                 @see
    63                     Root::Root
     58            /**
     59            @brief
     60                Default constructor.
     61            @note
     62                Should never be called as the singleton is automatically
     63                created during the creation of the Root object.
     64            @see
     65                Root::Root
    6466            */
    6567            DynLibManager();
    6668
    67             /** Default destructor.
    68                 @see
    69                     Root::~Root
     69            /**
     70            @brief
     71                Default destructor.
     72            @see
     73                Root::~Root
    7074            */
    7175            virtual ~DynLibManager();
    7276
    73             /** Loads the passed library.
    74                 @param
    75                     filename The name of the library. The extension can be omitted
     77            /**
     78            @brief
     79                Loads the passed library.
     80            @param filename
     81                The name of the library. The extension can be omitted
    7682            */
    7783            DynLib* load(const std::string& filename);
    7884
    79             /** Unloads the passed library.
    80             @param
    81             filename The name of the library. The extension can be omitted
     85            /**
     86            @brief
     87                Unloads the passed library.
     88            @param lib
     89                A pointer to the library object
    8290            */
    8391            void unload(DynLib* lib);
  • code/branches/doc/src/libraries/core/GUIManager.cc

    r7284 r7297  
    110110        After Lua setup tolua++-elements are linked to Lua-state to give Lua access to C++-code.
    111111        Finally initial Lua code is executed (maybe we can do this with the CEGUI startup script automatically).
    112     @param renderWindow
    113         Ogre's render window. Without this, the GUI cannot be displayed.
    114112    @return true if success, otherwise false
    115113    */
     
    237235    @param name
    238236        The name of the GUI
     237    @param bHidePrevious
     238        FIXME - add doc!
    239239
    240240        The function executes the Lua function with the same name in case the GUIManager is ready.
  • code/branches/doc/src/libraries/core/Identifier.h

    r7284 r7297  
    387387        @brief Adds an object of the given type to the ObjectList.
    388388        @param object The object to add
     389        @param className The name of the class T
     390        @param bRootClass True if this is a root class (i.e. it inherits directly from OrxonoxClass)
    389391    */
    390392    template <class T>
  • code/branches/doc/src/libraries/core/Language.cc

    r7284 r7297  
    168168        @brief Returns the localisation of a given entry.
    169169        @param label The label of the entry
     170        @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.
    170171        @return The localisation
    171172    */
  • code/branches/doc/src/libraries/core/Namespace.cc

    r6417 r7297  
    5555    }
    5656
    57     /**
    58         @brief XML loading and saving.
    59         @param xmlelement The XML-element
    60         @param loading Loading (true) or saving (false)
    61         @return The XML-element
    62     */
    6357    void Namespace::XMLPort(Element& xmlelement, XMLPort::Mode mode)
    6458    {
  • code/branches/doc/src/libraries/core/ObjectListBase.cc

    r5738 r7297  
    7070    /**
    7171        @brief Increases all Iterators that currently point on the given element (because it gets removed).
    72         @param element The element that gets removed
     72        @param object The object that gets removed
    7373    */
    7474    void ObjectListBase::notifyIterators(OrxonoxClass* object) const
     
    8282    /**
    8383        @brief Adds a new object to the end of the list.
    84         @param object The object to add
     84        @param element The element to add
    8585        @return The pointer to the new ObjectListBaseElement, needed by the MetaObjectList of the added object
    8686    */
  • code/branches/doc/src/libraries/core/ObjectListBase.h

    r5738 r7297  
    5454            /**
    5555                @brief Constructor: Creates the list-element with an object.
    56                 @param object The object to store
     56                @param objectBase The object to store
    5757            */
    5858            ObjectListBaseElement(OrxonoxClass* objectBase) : next_(0), prev_(0), objectBase_(objectBase) {}
  • code/branches/doc/src/libraries/core/ObjectListIterator.h

    r7268 r7297  
    109109            /**
    110110                @brief Assigns the element of another ObjectListIterator.
    111                 @param element The other ObjectListIterator
     111                @param other The other ObjectListIterator
    112112            */
    113113            inline ObjectListIterator<T>& operator=(const ObjectListIterator<T>& other)
  • code/branches/doc/src/libraries/core/Resource.h

    r6746 r7297  
    105105        /**
    106106            Find out if the named file exists.
    107         @param filename
     107        @param name
    108108            Fully qualified name of the file to test for
    109109        */
     
    112112        /**
    113113            Get struct with information about path and size.
    114         @param filename
     114        @param name
    115115            Fully qualified name of the file to test for
    116116        */
  • code/branches/doc/src/libraries/core/XMLPort.h

    r7291 r7297  
    148148    @param paramname The name of the attribute
    149149    @param loadfunction The function to set the attribute inside of the member object.
    150     @param loadfunction The function to get the attribute from the member object
     150    @param savefunction The function to get the attribute from the member object
     151    @param xmlelement The XML-element that is parsed by this macro
     152    @param mode Loading or saving
    151153
    152154    Sometimes you'll have a member object in your class, which has it's own load- and savefunctions.
     
    196198    @param sectionname The name of the subsection in the XML file that encloses the sub-objects ("" means no subsection)
    197199    @param loadfunction The function to add a new object to the class
    198     @param loadfunction The function to get all added objects from the class
     200    @param savefunction The function to get all added objects from the class
    199201    @param xmlelement The XMLElement (received through the XMLPort function)
    200202    @param mode The mode (load/save) (received through the XMLPort function)
  • code/branches/doc/src/libraries/core/command/TclThreadList.h

    r7284 r7297  
    7171
    7272            /**
    73                 @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).
     73                @brief Returns a reference to the mutex which might be useful if you want to iterate through the list (see @ref getList()).
    7474            */
    7575            inline boost::shared_mutex& getMutex() const
  • code/branches/doc/src/libraries/core/command/TclThreadManager.cc

    r7284 r7297  
    303303    /**
    304304        @brief Sends a command to the queue of a given Tcl-interpreter
    305         @param id The id of the target interpreter
     305        @param target_id The id of the target interpreter
    306306        @param command The command to be sent
    307307    */
     
    326326        @brief This function can be called from Tcl to send a command to the queue of any interpreter.
    327327        @param target_id The id of the target thread
     328        @param args Contains the content of the command
    328329    */
    329330    void TclThreadManager::tcl_crossexecute(int target_id, const Tcl::object& args)
     
    334335    /**
    335336        @brief Sends a command to the queue of a given Tcl-interpreter
    336         @param id The id of the target interpreter
     337        @param target_id The id of the target interpreter
    337338        @param command The command to be sent
    338339    */
     
    347348    /**
    348349        @brief Sends a query to a given Tcl-interpreter and waits for the result
    349         @param id The id of the target interpreter
     350        @param target_id The id of the target interpreter
    350351        @param command The command to be sent
    351352        @return The result of the command
     
    359360        @brief This function can be called from Tcl to send a query to the main thread.
    360361        @param source_id The id of the calling thread
     362        @param args Contains the content of the query
    361363
    362364        A query waits for the result of the command. This means, the calling thread will be blocked until
     
    373375        @param source_id The id of the calling thread
    374376        @param target_id The id of the target thread
     377        @param args Contains the content of the query
    375378    */
    376379    std::string TclThreadManager::tcl_crossquery(int source_id, int target_id, const Tcl::object& args)
  • code/branches/doc/src/libraries/core/input/InputManager.cc

    r7284 r7297  
    140140        Creates the OIS::InputMananger, the keyboard, the mouse and
    141141        the joys ticks. If either of the first two fail, this method throws an exception.
    142     @param windowWidth
    143         The width of the render window
    144     @param windowHeight
    145         The height of the render window
    146142    */
    147143    void InputManager::loadDevices()
  • code/branches/doc/src/libraries/core/input/InputManager.h

    r6746 r7297  
    122122        @param name
    123123            Unique name of the InputState when referenced as string
     124        @param bAlwaysGetsInput
     125            FIXME - add doc!
     126        @param bTransparent
     127            FIXME - add doc!
    124128        @param priority
    125129            Priority matters when multiple states are active. You can specify any
  • code/branches/doc/src/libraries/core/input/KeyBinder.cc

    r6536 r7297  
    495495    @brief
    496496        Event handler for the mouseMoved Event.
    497     @param e
    498         Mouse state information
     497    @param abs_
     498        The absolute position of the mouse
     499    @param rel_
     500        The relative movement of the mouse
     501    @param clippingSize
     502        FIXME - no doc? param not even used?
    499503    */
    500504    void KeyBinder::mouseMoved(IntVector2 abs_, IntVector2 rel_, IntVector2 clippingSize)
     
    551555    /**
    552556    @brief Event handler for the mouseScrolled Event.
    553     @param e Mouse state information
     557    @param abs The absolute position of the scroll wheel
     558    @param rel The relative movement of the scroll wheel
    554559    */
    555560    void KeyBinder::mouseScrolled(int abs, int rel)
  • code/branches/doc/src/libraries/network/ClientInformation.cc

    r6417 r7297  
    230230  * This function should only be applied to the head of the list
    231231  * @param clientID id to look for
     232  * @param look_backwards FIXME - add doc? parameter unused?
    232233  * @return pointer to the last element in the list or 0 if the search was unsuccessfull
    233234  */
     
    244245  * This function goes forward through the list and looks for an element with clientID
    245246  * This function should only be applied to the head of the list
    246   * @param peer peer to look for
     247  * @param address peer to look for
     248  * @param look_backwards FIXME - add doc? parameter unused?
    247249  * @return pointer to the element in the list
    248250  */
  • code/branches/doc/src/libraries/network/synchronisable/Synchronisable.cc

    r7183 r7297  
    217217   * length of varx: size saved int syncvarlist
    218218   * @param mem pointer to allocated memory with enough size
     219   * @param sizes FIXME - add doc!
    219220   * @param id gamestateid of the gamestate to be saved (important for priorities)
    220221   * @param mode defines the direction in which the data will be send/received
     
    288289   * @param mem pointer to the bytestream
    289290   * @param mode same as in getData
     291   * @param forceCallback FIXME - add doc!
    290292   * @return true/false
    291293   */
     
    364366   * This function determines, wheter the object should be saved to the bytestream (according to its syncmode/direction)
    365367   * @param id gamestate id
     368   * @param mode FIXME - add doc!
    366369   * @return true/false
    367370   */
  • code/branches/doc/src/libraries/tools/ResourceCollection.cc

    r5781 r7297  
    5252    }
    5353
    54     void ResourceCollection::XMLPort(Element& xmlElement, XMLPort::Mode mode)
     54    void ResourceCollection::XMLPort(Element& xmlelement, XMLPort::Mode mode)
    5555    {
    56         XMLPortParam(ResourceCollection, "resourceGroup", setResourceGroup, getResourceGroup, xmlElement, mode);
    57         XMLPortObject(ResourceCollection, ResourceLocation, "", addResourceLocation, getResourceLocation, xmlElement, mode);
     56        XMLPortParam(ResourceCollection, "resourceGroup", setResourceGroup, getResourceGroup, xmlelement, mode);
     57        XMLPortObject(ResourceCollection, ResourceLocation, "", addResourceLocation, getResourceLocation, xmlelement, mode);
    5858    }
    5959
  • code/branches/doc/src/libraries/tools/ResourceCollection.h

    r6105 r7297  
    4444        virtual ~ResourceCollection();
    4545
    46         virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
     46        virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
    4747
    4848        void setResourceGroup(const std::string& resourceGroup);
  • code/branches/doc/src/libraries/tools/ResourceLocation.cc

    r7174 r7297  
    5656    }
    5757
    58     void ResourceLocation::XMLPort(Element& xmlElement, XMLPort::Mode mode)
     58    void ResourceLocation::XMLPort(Element& xmlelement, XMLPort::Mode mode)
    5959    {
    60         XMLPortParam(ResourceLocation, "path",        setPath,        getPath,        xmlElement, mode);
    61         XMLPortParam(ResourceLocation, "archiveType", setArchiveType, getArchiveType, xmlElement, mode);
    62         XMLPortParam(ResourceLocation, "recursive",   setRecursive,   getRecursive,   xmlElement, mode);
     60        XMLPortParam(ResourceLocation, "path",        setPath,        getPath,        xmlelement, mode);
     61        XMLPortParam(ResourceLocation, "archiveType", setArchiveType, getArchiveType, xmlelement, mode);
     62        XMLPortParam(ResourceLocation, "recursive",   setRecursive,   getRecursive,   xmlelement, mode);
    6363        if (path_.empty())
    6464            ThrowException(AbortLoading, "ResourceLocation: No path given.");
  • code/branches/doc/src/libraries/tools/ResourceLocation.h

    r5781 r7297  
    4646        virtual ~ResourceLocation();
    4747
    48         virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
     48        virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
    4949
    5050        void setPath(const std::string& path) { path_ = path; }
  • code/branches/doc/src/libraries/tools/Timer.cc

    r7284 r7297  
    9595        @param interval The timer-interval in seconds
    9696        @param bLoop If true, the function gets called every 'interval' seconds
    97         @param exeuctor A executor of the function to call
     97        @param executor A executor of the function to call
     98        @param bKillAfterCall If true, the timer will be deleted after the function was executed
    9899    */
    99100    Timer::Timer(float interval, bool bLoop, const ExecutorPtr& executor, bool bKillAfterCall)
  • code/branches/doc/src/libraries/tools/Timer.h

    r7284 r7297  
    8585                @param interval The timer-interval in seconds
    8686                @param bLoop If true, the function gets called every 'interval' seconds
    87                 @param object The object owning the timer and the function
    8887                @param executor A executor of the function to call
     88                @param bKillAfterCall If true, the timer will be deleted after the function was executed
    8989            */
    9090            void setTimer(float interval, bool bLoop, const ExecutorPtr& executor, bool bKillAfterCall = false)
  • code/branches/doc/src/libraries/util/Convert.h

    r7284 r7297  
    278278        For information about the different conversion methods (user defined too), see the section
    279279        'Actual conversion sequence' in this file above.
     280    @param output
     281        A pointer to the variable where the converted value will be stored
     282    @param input
     283        The original value
    280284    */
    281285    template <class FromType, class ToType>
     
    294298        'Actual conversion sequence' in this file above.
    295299        If the conversion doesn't succeed, 'fallback' is written to '*output'.
     300    @param output
     301        A pointer to the variable where the converted value will be stored
     302    @param input
     303        The original value
    296304    @param fallback
    297305        A default value that gets written to '*output' if there is no conversion.
  • code/branches/doc/src/libraries/util/Exception.h

    r6417 r7297  
    6060        @param description
    6161            Exception description as string. This message is supposed to help developers!
     62        @param lineNumber
     63            The number of the code-line in which the exception occurred
     64        @param filename
     65            The file in which the exception occurred
     66        @param functionName
     67            The function in which the exception occurred
    6268        */
    6369        Exception(const std::string& description, unsigned int lineNumber,
  • code/branches/doc/src/libraries/util/OutputHandler.cc

    r6417 r7297  
    6767        @brief
    6868            Gets temporary log path and starts the log file
    69         @param outputHandler
    70             This is only required to avoid another call to getInstance (this c'tor was
    71             called from getInstance!)
    7269        */
    7370        LogFileWriter()
     
    162159        @brief
    163160            Sets the right soft debug level and registers itself
    164         @param outputHandler
    165             This is only required to avoid another call to getInstance (this c'tor was
    166             called from getInstance!)
    167161        */
    168162        MemoryLogWriter()
  • code/branches/doc/src/libraries/util/StringUtils.cc

    r7284 r7297  
    142142    /**
    143143        @brief Returns true if the string contains something like '..."between quotes"...'.
    144         @param The string
     144        @param str The string
    145145        @return True if there is something between quotes
    146146    */
     
    154154    /**
    155155        @brief If the string contains something like '..."between quotes"...' then 'between quotes' gets returned (without quotes).
    156         @param The string
    157         @param The string between the quotes
     156        @param str The string between the quotes
    158157    */
    159158    std::string getStringBetweenQuotes(const std::string& str)
     
    169168    /**
    170169        @brief Removes enclosing quotes if available (including whitespaces at the outside of the quotes).
    171         @brief str The string to strip
     170        @param str The string to strip
    172171        @return The string with removed quotes
    173172    */
  • code/branches/doc/src/libraries/util/SubString.cc

    r7284 r7297  
    6262
    6363    /**
    64      * @brief Splits a String into multiple splitters.
    65      * @param string the String to split
    66      * @param delimiters multiple set of characters at what to split. (delimiters)
    67      * @param delimiterNeighbours neighbours of the delimiters, that will be erased only when near a delimiter.
    68      * @param emptyEntries If empty entries should be allewed or removed.
    69      * @param escapeChar The Escape Character that overrides splitters commends and so on...
    70      * @param safemode_char within these characters splitting won't happen
    71      * @param comment_char the Comment character.
     64     * @brief Splits a string into multiple tokens.
     65     * @param string The string to split
     66     * @param delimiters Multiple set of characters at what to split. (delimiters)
     67     * @param delimiterNeighbours Neighbours of the delimiters that will be erased as well.
     68     * @param emptyEntries If empty entries are added to the list of SubStrings
     69     * @param escapeChar The escape character that overrides splitters commends and so on...
     70     * @param removeEscapeChar If true, the escape char is removed from the tokens
     71     * @param safemode_char Within these characters splitting won't happen
     72     * @param removeSafemodeChar Removes the safemode_char from the beginning and the ending of a token
     73     * @param openparenthesis_char The beginning of a safemode is marked with this
     74     * @param closeparenthesis_char The ending of a safemode is marked with this
     75     * @param removeParenthesisChars Removes the parenthesis from the beginning and the ending of a token
     76     * @param comment_char The comment character.
    7277     */
    7378    SubString::SubString(const std::string& string,
     
    234239
    235240    /**
    236      * @brief Splits a String into multiple splitters.
    237      * @param string the String to split
    238      * @param delimiters multiple set of characters at what to split. (delimiters)
    239      * @param delimiterNeighbours: Neighbours to the Delimiters that will be erased too.
    240      * @param emptyEntries: If empty entries are added to the List of SubStrings
    241      * @param escapeChar The Escape Character that overrides splitters commends and so on...
    242      * @param safemode_char within these characters splitting won't happen
    243      * @param comment_char the Comment character.
     241     * @brief Splits a string into multiple tokens.
     242     * @param string The string to split
     243     * @param delimiters Multiple set of characters at what to split. (delimiters)
     244     * @param delimiterNeighbours: Neighbours of the delimiters that will be erased too.
     245     * @param emptyEntries: If empty entries are added to the list of SubStrings
     246     * @param escapeChar The escape character that overrides splitters commends and so on...
     247     * @param removeEscapeChar If true, the escape char is removed from the tokens
     248     * @param safemode_char Within these characters splitting won't happen
     249     * @param removeSafemodeChar Removes the safemode_char from the beginning and the ending of a token
     250     * @param openparenthesis_char The beginning of a safemode is marked with this
     251     * @param closeparenthesis_char The ending of a safemode is marked with this
     252     * @param removeParenthesisChars Removes the parenthesis from the beginning and the ending of a token
     253     * @param comment_char The comment character.
    244254     */
    245255    unsigned int SubString::split(const std::string& string,
    246256                                  const std::string& delimiters, const std::string& delimiterNeighbours, bool emptyEntries,
    247                                   char escapeChar, bool removeExcapeChar, char safemode_char, bool removeSafemodeChar,
     257                                  char escapeChar, bool removeEscapeChar, char safemode_char, bool removeSafemodeChar,
    248258                                  char openparenthesis_char, char closeparenthesis_char, bool removeParenthesisChars, char comment_char)
    249259    {
    250260        this->strings.clear();
    251261        this->bInSafemode.clear();
    252         SubString::splitLine(this->strings, this->bInSafemode, string, delimiters, delimiterNeighbours, emptyEntries, escapeChar, removeExcapeChar, safemode_char, removeSafemodeChar, openparenthesis_char, closeparenthesis_char, removeParenthesisChars, comment_char);
     262        SubString::splitLine(this->strings, this->bInSafemode, string, delimiters, delimiterNeighbours, emptyEntries, escapeChar, removeEscapeChar, safemode_char, removeSafemodeChar, openparenthesis_char, closeparenthesis_char, removeParenthesisChars, comment_char);
    253263        return this->strings.size();
    254264    }
     
    304314
    305315    /**
    306      * @brief splits line into tokens and stores them in ret.
    307      * @param ret the Array, where the Splitted strings will be stored in
    308      * to the beginning of the current token is stored
    309      * @param line the inputLine to split
    310      * @param delimiters a String of Delimiters (here the input will be splitted)
    311      * @param delimiterNeighbours Neighbours to the Delimiter, that will be removed if they are to the left or the right of a Delimiter.
    312      * @param emptyEntries: if empty Strings are added to the List of Strings.
    313      * @param escape_char: Escape carater (escapes splitters)
    314      * @param safemode_char: the beginning of the safemode is marked with this
    315      * @param removeSafemodeChar removes the safemode_char from the beginning and the ending of a token
    316      * @param openparenthesis_char the beginning of a safemode is marked with this
    317      * @param closeparenthesis_char the ending of a safemode is marked with this
    318      * @param removeParenthesisChars removes the parenthesis from the beginning and the ending of a token
    319      * @param comment_char: the beginning of a comment is marked with this: (until the end of a Line)
    320      * @param start_state: the Initial state on how to parse the String.
     316     * @brief Splits a line into tokens and stores them in ret.
     317     * @param ret The array, where the splitted strings will be stored in
     318     * @param bInSafemode A vector wich stores for each character of the string if it is in safemode or not
     319     * @param line The inputLine to split
     320     * @param delimiters A string of delimiters (here the input will be splitted)
     321     * @param delimiterNeighbours Neighbours of the delimiter, that will be removed if they are to the left or the right of a delimiter.
     322     * @param emptyEntries If empty strings are added to the list of strings.
     323     * @param escape_char Escape carater (escapes splitters)
     324     * @param removeEscapeChar If true, the escape char is removed from the tokens
     325     * @param safemode_char The beginning of the safemode is marked with this
     326     * @param removeSafemodeChar Removes the safemode_char from the beginning and the ending of a token
     327     * @param openparenthesis_char The beginning of a safemode is marked with this
     328     * @param closeparenthesis_char The ending of a safemode is marked with this
     329     * @param removeParenthesisChars Removes the parenthesis from the beginning and the ending of a token
     330     * @param comment_char The beginning of a comment is marked with this: (until the end of a line)
     331     * @param start_state The initial state on how to parse the string.
    321332     * @return SPLIT_LINE_STATE the parser was in when returning
    322333     *
     
    333344                         bool emptyEntries,
    334345                         char escape_char,
    335                          bool removeExcapeChar,
     346                         bool removeEscapeChar,
    336347                         char safemode_char,
    337348                         bool removeSafemodeChar,
     
    368379                {
    369380                    state = SL_ESCAPE;
    370                     if (!removeExcapeChar)
     381                    if (!removeEscapeChar)
    371382                        token += line[i];
    372383                }
  • code/branches/doc/src/libraries/util/SubString.h

    r7291 r7297  
    115115        unsigned int split(const std::string& string,
    116116                           const std::string& delimiters, const std::string& delimiterNeighbours = "", bool emptyEntries = false,
    117                            char escapeChar ='\\', bool removeExcapeChar = true, char safemode_char = '"', bool removeSafemodeChar = true,
     117                           char escapeChar ='\\', bool removeEscapeChar = true, char safemode_char = '"', bool removeSafemodeChar = true,
    118118                           char openparenthesis_char = '{', char closeparenthesis_char = '}',  bool removeParenthesisChars = true, char comment_char = '\0');
    119119        std::string join(const std::string& delimiter = " ") const;
     
    152152                                          bool emptyEntries = false,
    153153                                          char escape_char = '\\',
    154                                           bool removeExcapeChar = true,
     154                                          bool removeEscapeChar = true,
    155155                                          char safemode_char = '"',
    156156                                          bool removeSafemodeChar = true,
  • code/branches/doc/src/modules/notifications/Notification.cc

    r7193 r7297  
    5555    @brief
    5656        Constructor. Creates a Notification with the input message.
     57    @param creator
     58        The object that created this Notification
    5759    @param message
    5860        The message of the Notification.
  • code/branches/doc/src/modules/notifications/NotificationQueue.cc

    r7163 r7297  
    109109        Method for creating a NotificationQueue object through XML.
    110110    */
    111     void NotificationQueue::XMLPort(Element& xmlElement, XMLPort::Mode mode)
    112     {
    113         SUPER(NotificationQueue, XMLPort, xmlElement, mode);
     111    void NotificationQueue::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     112    {
     113        SUPER(NotificationQueue, XMLPort, xmlelement, mode);
    114114
    115115        this->setDefaults();
    116116
    117         XMLPortParam(NotificationQueue, "maxSize", setMaxSize, getMaxSize, xmlElement, mode);
    118         XMLPortParam(NotificationQueue, "notificationLength", setNotificationLength, getNotificationLength, xmlElement, mode);
    119         XMLPortParam(NotificationQueue, "displayTime", setDisplayTime, getDisplayTime, xmlElement, mode);
    120         XMLPortParam(NotificationQueue, "targets", setTargets, getTargets, xmlElement, mode);
    121         XMLPortParam(NotificationQueue, "font", setFont, getFont, xmlElement, mode);
    122         XMLPortParam(NotificationQueue, "fontSize", setFontSize, getFontSize, xmlElement, mode);
    123         XMLPortParam(NotificationQueue, "position", setPosition, getPosition, xmlElement, mode);
     117        XMLPortParam(NotificationQueue, "maxSize", setMaxSize, getMaxSize, xmlelement, mode);
     118        XMLPortParam(NotificationQueue, "notificationLength", setNotificationLength, getNotificationLength, xmlelement, mode);
     119        XMLPortParam(NotificationQueue, "displayTime", setDisplayTime, getDisplayTime, xmlelement, mode);
     120        XMLPortParam(NotificationQueue, "targets", setTargets, getTargets, xmlelement, mode);
     121        XMLPortParam(NotificationQueue, "font", setFont, getFont, xmlelement, mode);
     122        XMLPortParam(NotificationQueue, "fontSize", setFontSize, getFontSize, xmlelement, mode);
     123        XMLPortParam(NotificationQueue, "position", setPosition, getPosition, xmlelement, mode);
    124124
    125125        COUT(3) << "NotificationQueue '" << this->getName() << "' created." << std::endl;
  • code/branches/doc/src/modules/notifications/NotificationQueue.h

    r7164 r7297  
    9393            virtual ~NotificationQueue();
    9494
    95             virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode); //!< Method for creating a NotificationQueue object through XML.
     95            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a NotificationQueue object through XML.
    9696
    9797            virtual void tick(float dt); //!< To update from time to time.
  • code/branches/doc/src/modules/objects/Planet.cc

    r7163 r7297  
    144144    }
    145145
    146     /**
    147         @brief XML loading and saving.
    148         @param xmlelement The XML-element
    149         @param loading Loading (true) or saving (false)
    150         @return The XML-element
    151     */
    152146    void Planet::XMLPort(Element& xmlelement, XMLPort::Mode mode)
    153147    {
  • code/branches/doc/src/modules/objects/triggers/DistanceMultiTrigger.h

    r7163 r7297  
    6565            /**
    6666            @brief Set the target name of DistanceTriggerBeacons that triggers this DistanceMultiTrigger.
    67             @param targename The name of the DistanceTriggerBeacon as a string.
     67            @param targetname The name of the DistanceTriggerBeacon as a string.
    6868            */
    6969            inline void setTargetName(const std::string& targetname)
  • code/branches/doc/src/modules/objects/triggers/MultiTrigger.cc

    r7163 r7297  
    308308    @brief
    309309        Get whether the MultiTrigger is active for a given object.
    310     @param triggerers
     310    @param triggerer
    311311        A pointer to the object.
    312312    @return
  • code/branches/doc/src/modules/overlays/FadeoutText.h

    r5929 r7297  
    4444            virtual ~FadeoutText() {}
    4545
    46             virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
     46            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
    4747            virtual void tick(float dt);
    4848
  • code/branches/doc/src/modules/overlays/GUIOverlay.cc

    r7163 r7297  
    5252    }
    5353
    54     void GUIOverlay::XMLPort(Element& xmlElement, XMLPort::Mode mode)
     54    void GUIOverlay::XMLPort(Element& xmlelement, XMLPort::Mode mode)
    5555    {
    56         SUPER(GUIOverlay, XMLPort, xmlElement, mode);
     56        SUPER(GUIOverlay, XMLPort, xmlelement, mode);
    5757
    58         XMLPortParam(GUIOverlay, "guiname", setGUIName, getGUIName, xmlElement, mode);
     58        XMLPortParam(GUIOverlay, "guiname", setGUIName, getGUIName, xmlelement, mode);
    5959    }
    6060
  • code/branches/doc/src/modules/overlays/GUIOverlay.h

    r6753 r7297  
    4444            virtual ~GUIOverlay();
    4545
    46             virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
     46            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
    4747
    4848            void setGUIName(const std::string& name);
  • code/branches/doc/src/modules/overlays/OverlayText.cc

    r6417 r7297  
    7171    }
    7272
    73     void OverlayText::XMLPort(Element& xmlElement, XMLPort::Mode mode)
     73    void OverlayText::XMLPort(Element& xmlelement, XMLPort::Mode mode)
    7474    {
    75         SUPER(OverlayText, XMLPort, xmlElement, mode);
     75        SUPER(OverlayText, XMLPort, xmlelement, mode);
    7676
    77         XMLPortParam(OverlayText, "font",       setFont,            getFont,            xmlElement, mode);
    78         XMLPortParam(OverlayText, "colour",     setColour,          getColour,          xmlElement, mode);
    79         XMLPortParam(OverlayText, "caption",    setCaption,         getCaption,         xmlElement, mode);
    80         XMLPortParam(OverlayText, "textsize",   setTextSize,        getTextSize,        xmlElement, mode);
    81         XMLPortParam(OverlayText, "align",      setAlignmentString, getAlignmentString, xmlElement, mode);
    82         XMLPortParam(OverlayText, "spacewidth", setSpaceWidth,      getSpaceWidth,      xmlElement, mode);
     77        XMLPortParam(OverlayText, "font",       setFont,            getFont,            xmlelement, mode);
     78        XMLPortParam(OverlayText, "colour",     setColour,          getColour,          xmlelement, mode);
     79        XMLPortParam(OverlayText, "caption",    setCaption,         getCaption,         xmlelement, mode);
     80        XMLPortParam(OverlayText, "textsize",   setTextSize,        getTextSize,        xmlelement, mode);
     81        XMLPortParam(OverlayText, "align",      setAlignmentString, getAlignmentString, xmlelement, mode);
     82        XMLPortParam(OverlayText, "spacewidth", setSpaceWidth,      getSpaceWidth,      xmlelement, mode);
    8383    }
    8484
  • code/branches/doc/src/modules/overlays/OverlayText.h

    r5781 r7297  
    5252        virtual ~OverlayText();
    5353
    54         virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
     54        virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
    5555
    5656        void setCaption(const std::string& caption);
  • code/branches/doc/src/modules/overlays/hud/HUDBar.cc

    r6677 r7297  
    5555    }
    5656
    57     void BarColour::XMLPort(Element& xmlElement, XMLPort::Mode mode)
    58     {
    59         SUPER(BarColour, XMLPort, xmlElement, mode);
    60 
    61         XMLPortParam(BarColour, "colour", setColour, getColour, xmlElement, mode);
    62         XMLPortParam(BarColour, "position", setPosition, getPosition, xmlElement, mode);
     57    void BarColour::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     58    {
     59        SUPER(BarColour, XMLPort, xmlelement, mode);
     60
     61        XMLPortParam(BarColour, "colour", setColour, getColour, xmlelement, mode);
     62        XMLPortParam(BarColour, "position", setPosition, getPosition, xmlelement, mode);
    6363    }
    6464
     
    104104    }
    105105
    106     void HUDBar::XMLPort(Element& xmlElement, XMLPort::Mode mode)
    107     {
    108         SUPER(HUDBar, XMLPort, xmlElement, mode);
    109 
    110         XMLPortParam(HUDBar, "initialvalue", setValue,       getValue,       xmlElement, mode);
    111         XMLPortParam(HUDBar, "righttoleft",  setRightToLeft, getRightToLeft, xmlElement, mode);
    112         XMLPortParam(HUDBar, "autocolour",   setAutoColour,  getAutoColour,  xmlElement, mode);
    113         XMLPortParam(HUDBar, "bartexture",   setBarTexture,  getBarTexture, xmlElement, mode);
    114         XMLPortObject(HUDBar, BarColour, "", addColour, getColour, xmlElement, mode);
     106    void HUDBar::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     107    {
     108        SUPER(HUDBar, XMLPort, xmlelement, mode);
     109
     110        XMLPortParam(HUDBar, "initialvalue", setValue,       getValue,       xmlelement, mode);
     111        XMLPortParam(HUDBar, "righttoleft",  setRightToLeft, getRightToLeft, xmlelement, mode);
     112        XMLPortParam(HUDBar, "autocolour",   setAutoColour,  getAutoColour,  xmlelement, mode);
     113        XMLPortParam(HUDBar, "bartexture",   setBarTexture,  getBarTexture, xmlelement, mode);
     114        XMLPortObject(HUDBar, BarColour, "", addColour, getColour, xmlelement, mode);
    115115    }
    116116
  • code/branches/doc/src/modules/overlays/hud/HUDBar.h

    r5781 r7297  
    5050        virtual ~BarColour() { }
    5151
    52         virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
     52        virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
    5353
    5454        void setColour(const ColourValue& colour) { this->colour_ = colour; }
     
    7070        virtual ~HUDBar();
    7171
    72         virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
     72        virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
    7373
    7474        void clearColours();
  • code/branches/doc/src/modules/overlays/hud/HUDHealthBar.h

    r6417 r7297  
    4545            virtual ~HUDHealthBar();
    4646
    47             virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
     47            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
    4848            virtual void tick(float dt);
    4949            virtual void changedOwner();
  • code/branches/doc/src/modules/overlays/hud/HUDNavigation.cc

    r7163 r7297  
    9090}
    9191
    92 void HUDNavigation::XMLPort ( Element& xmlElement, XMLPort::Mode mode )
    93 {
    94     SUPER ( HUDNavigation, XMLPort, xmlElement, mode );
    95 
    96     XMLPortParam ( HUDNavigation, "font",          setFont,          getFont,          xmlElement, mode );
    97     XMLPortParam ( HUDNavigation, "textSize",      setTextSize,      getTextSize,      xmlElement, mode );
    98     XMLPortParam ( HUDNavigation, "navMarkerSize", setNavMarkerSize, getNavMarkerSize, xmlElement, mode );
     92void HUDNavigation::XMLPort ( Element& xmlelement, XMLPort::Mode mode )
     93{
     94    SUPER ( HUDNavigation, XMLPort, xmlelement, mode );
     95
     96    XMLPortParam ( HUDNavigation, "font",          setFont,          getFont,          xmlelement, mode );
     97    XMLPortParam ( HUDNavigation, "textSize",      setTextSize,      getTextSize,      xmlelement, mode );
     98    XMLPortParam ( HUDNavigation, "navMarkerSize", setNavMarkerSize, getNavMarkerSize, xmlelement, mode );
    9999}
    100100
  • code/branches/doc/src/modules/overlays/hud/HUDNavigation.h

    r7163 r7297  
    5151    void setConfigValues();
    5252
    53     virtual void XMLPort ( Element& xmlElement, XMLPort::Mode mode );
     53    virtual void XMLPort ( Element& xmlelement, XMLPort::Mode mode );
    5454    virtual void tick ( float dt );
    5555
  • code/branches/doc/src/modules/overlays/hud/HUDRadar.cc

    r7184 r7297  
    8282    }
    8383
    84     void HUDRadar::XMLPort(Element& xmlElement, XMLPort::Mode mode)
     84    void HUDRadar::XMLPort(Element& xmlelement, XMLPort::Mode mode)
    8585    {
    86         SUPER(HUDRadar, XMLPort, xmlElement, mode);
     86        SUPER(HUDRadar, XMLPort, xmlelement, mode);
    8787
    88         XMLPortParam(HUDRadar, "sensitivity", setRadarSensitivity, getRadarSensitivity, xmlElement, mode);
    89         XMLPortParam(HUDRadar, "halfDotSizeDistance", setHalfDotSizeDistance, getHalfDotSizeDistance, xmlElement, mode);
    90         XMLPortParam(HUDRadar, "maximumDotSize", setMaximumDotSize, getMaximumDotSize, xmlElement, mode);
     88        XMLPortParam(HUDRadar, "sensitivity", setRadarSensitivity, getRadarSensitivity, xmlelement, mode);
     89        XMLPortParam(HUDRadar, "halfDotSizeDistance", setHalfDotSizeDistance, getHalfDotSizeDistance, xmlelement, mode);
     90        XMLPortParam(HUDRadar, "maximumDotSize", setMaximumDotSize, getMaximumDotSize, xmlelement, mode);
    9191    }
    9292
  • code/branches/doc/src/modules/overlays/hud/HUDRadar.h

    r7163 r7297  
    4949        virtual ~HUDRadar();
    5050
    51         virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
     51        virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
    5252        virtual void changedOwner();
    5353
  • code/branches/doc/src/modules/overlays/stats/Scoreboard.cc

    r6502 r7297  
    5454            this->lines_.pop_back();
    5555        }
    56     }
    57 
    58     /**
    59         @brief Initializes the lines.
    60     */
    61     void Scoreboard::XMLPort(Element& xmlElement, XMLPort::Mode mode)
    62     {
    63         SUPER(Scoreboard, XMLPort, xmlElement, mode);
    6456    }
    6557
  • code/branches/doc/src/modules/overlays/stats/Scoreboard.h

    r5929 r7297  
    4444        virtual ~Scoreboard();
    4545
    46         virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
    4746        virtual void tick(float dt);
    4847
  • code/branches/doc/src/modules/overlays/stats/Stats.cc

    r6502 r7297  
    9898    }
    9999
    100     /**
    101         @brief Initializes the Stats panel.
    102     */
    103     void Stats::XMLPort(Element& xmlElement, XMLPort::Mode mode)
    104     {
    105         OrxonoxOverlay::XMLPort(xmlElement, mode);
    106     }
    107 
    108100    void Stats::tick(float dt)
    109101    {
  • code/branches/doc/src/modules/overlays/stats/Stats.h

    r5781 r7297  
    4646        void setConfigValues();
    4747
    48         virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
    49 
    5048        virtual void tick(float dt);
    5149
  • code/branches/doc/src/modules/pickup/DroppedPickup.cc

    r7163 r7297  
    6161    @param pickup
    6262        The Pickupable that was dropped.
    63     @param position
    64         The position at which the DroppedPickup should be created.
     63    @param carrier
     64        FIXME - add doc!
    6565    @param triggerDistance
    6666        The distance at which the PickupSpawner triggers. Default is 10.
  • code/branches/doc/src/modules/pickup/Pickup.cc

    r7208 r7297  
    225225        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.:
    226226        DroppedPickup(BaseObject* creator, Pickupable* pickup, const Vector3& position);
    227     @param position
    228         The position at which the PickupSpawner should be placed.
    229227    @return
    230228        Returns true if a spawner was created, false if not.
  • code/branches/doc/src/modules/pickup/PickupCollection.cc

    r7163 r7297  
    228228    @brief
    229229        Get whether a given class, represented by the input Identifier, is a target of this PickupCollection.
    230     @param identifier
    231         A pointer to the PickupIdentifier of the PickupCarrier we want to know of, whether it is a target of this PickupCollection.
     230    @param carrier
     231        A pointer to the PickupCarrier we want to know of, whether it is a target of this PickupCollection.
    232232    @return
    233233        Returns true if the PickupCarrier identified by the input PickupIdentififer it is a target of this PickupCollection, false if not.
     
    336336        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.:
    337337        DroppedPickup(BaseObject* creator, Pickupable* pickup, const Vector3& position);
    338     @param position
    339         The position at which the PickupSpawner should be placed.
    340338    @return
    341339        Returns true if a spawner was created, false if not.
  • code/branches/doc/src/modules/pickup/PickupCollectionIdentifier.cc

    r7163 r7297  
    9999    @brief
    100100        Add a Pickupable to the PickupCollectionIdentifier.
    101     @param
     101    @param identifier
    102102        A pointer to the PickupIdentifier of the Pickupable to be added.
    103103    */
  • code/branches/doc/src/modules/pickup/PickupSpawner.cc

    r7163 r7297  
    7070    @param respawnTime
    7171        The minimum time between two spawns.
    72     @param maySpawnedItems
     72    @param maxSpawnedItems
    7373        The maximum number of items spawned by this PickupSpawner.
    7474    */
  • code/branches/doc/src/modules/pickup/items/SpeedPickup.cc

    r7208 r7297  
    252252    @brief
    253253        Sets the SpeedMultiply
    254     @param speedAdd
     254    @param speedMultiply
    255255        The multiplied Speed
    256256    */
  • code/branches/doc/src/modules/questsystem/AddQuestHint.cc

    r7163 r7297  
    8080    @param id
    8181        The QuestHint id.
    82     @param
     82    @return
    8383        Returns true if successful.
    8484    */
  • code/branches/doc/src/modules/questsystem/Quest.cc

    r7163 r7297  
    197197    @brief
    198198        Returns the subquest at the given index.
    199     @param
     199    @param index
    200200        The index.
    201201    @return
     
    222222    @brief
    223223        Returns the QuestHint at the given index.
    224     @param
     224    @param index
    225225        The index.
    226226    @return
     
    246246    @brief
    247247        Returns the fail QuestEffect at the given index.
    248     @param
     248    @param index
    249249        The index.
    250250    @return
     
    270270    @brief
    271271        Returns the complete QuestEffect at the given index.
    272     @param
     272    @param index
    273273        The index.
    274274    @return
  • code/branches/doc/src/modules/questsystem/QuestEffectBeacon.cc

    r7163 r7297  
    9292        Executes the QuestEffectBeacon.
    9393        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.
     94    @param b
     95        true means the trigger was activated while false means it was deactivated
    9496    @param trigger
    9597        A pointer to the PlayerTrigger that threw the Event.
  • code/branches/doc/src/modules/questsystem/QuestNotification.cc

    r7163 r7297  
    4848    @brief
    4949        Creates a QuestNotification with the input message.
     50    @param creator
     51        The creator of this object
    5052    @param message
    5153        The message to be sent.
  • code/branches/doc/src/orxonox/controllers/ArtificialController.cc

    r7284 r7297  
    665665        @brief Master begins to follow a pawn. Is a "specific master action".
    666666        @param pawn pawn to follow.
    667         @param alaways follows pawn forever if true (false if omitted).
     667        @param always follows pawn forever if true (false if omitted).
    668668        @param secondsToFollow seconds to follow the pawn if always is false. Will follow pawn 100 seconds if omitted (set in header).
    669669    */
  • code/branches/doc/src/orxonox/graphics/Light.h

    r7163 r7297  
    8383            /**
    8484                @brief Sets the attenuation parameters of the light source i.e. how it diminishes with distance.
     85                @param attenuation The parameters of the attenuation (see description)
    8586
    86                 @param attenuation.x range (The absolute upper range of the light in world units)
    87                 @param attenuation.y constant (The constant factor in the attenuation formula: 1.0 means never attenuate, 0.0 is complete attenuation)
    88                 @param attenuation.z linear (The linear factor in the attenuation formula: 1 means attenuate evenly over the distance)
    89                 @param attenuation.w quadratic (The quadratic factor in the attenuation formula: adds a curvature to the attenuation formula)
     87                 - @a attenuation.x range (The absolute upper range of the light in world units)
     88                 - @a attenuation.y constant (The constant factor in the attenuation formula: 1.0 means never attenuate, 0.0 is complete attenuation)
     89                 - @a attenuation.z linear (The linear factor in the attenuation formula: 1 means attenuate evenly over the distance)
     90                 - @a attenuation.w quadratic (The quadratic factor in the attenuation formula: adds a curvature to the attenuation formula)
    9091
    9192                Quote from the Ogre API:
     
    120121            /**
    121122                @brief Sets the range of a spotlight, i.e. the angle of the inner and outer cones and the rate of falloff between them.
    122 
    123                 @param spotlightRange.x innerAngle (The angle covered by the bright inner cone)
    124                 @param spotlightRange.x outerAngle (The angle covered by the outer cone)
    125                 @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.)
     123                @param spotlightRange The parameters of the spotlight (see description)
     124               
     125                 - @a spotlightRange.x innerAngle (The angle covered by the bright inner cone)
     126                 - @a spotlightRange.x outerAngle (The angle covered by the outer cone)
     127                 - @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.)
    126128            */
    127129            inline void setSpotlightRange(const Vector3& spotlightRange)
  • code/branches/doc/src/orxonox/interfaces/Pickupable.h

    r7296 r7297  
    162162                   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.:
    163163                   DroppedPickup(BaseObject* creator, Pickupable* pickup, PickupCarrier* carrier, float triggerDistance);
    164             @param position The position at which the PickupSpawner should be placed.
    165164            @return Returns true if a spawner was created, false if not.
    166165            */
  • code/branches/doc/src/orxonox/overlays/GUISheet.cc

    r7163 r7297  
    5454    }
    5555
    56     void GUISheet::XMLPort(Element& xmlElement, XMLPort::Mode mode)
     56    void GUISheet::XMLPort(Element& xmlelement, XMLPort::Mode mode)
    5757    {
    58         SUPER(GUISheet, XMLPort, xmlElement, mode);
     58        SUPER(GUISheet, XMLPort, xmlelement, mode);
    5959
    60         XMLPortParam(GUISheet, "showOnLoad",   setShowOnLoad,     getShowOnLoad,     xmlElement, mode);
    61         XMLPortParam(GUISheet, "hidePrevious", setPreviousHiding, getPreviousHiding, xmlElement, mode);
    62         XMLPortParam(GUISheet, "sheetName",    setSheetName,      getSheetName,      xmlElement, mode);
    63         XMLPortParam(GUISheet, "backgroundImage",  setBackgroundImage,  getBackgroundImage,  xmlElement, mode);
     60        XMLPortParam(GUISheet, "showOnLoad",   setShowOnLoad,     getShowOnLoad,     xmlelement, mode);
     61        XMLPortParam(GUISheet, "hidePrevious", setPreviousHiding, getPreviousHiding, xmlelement, mode);
     62        XMLPortParam(GUISheet, "sheetName",    setSheetName,      getSheetName,      xmlelement, mode);
     63        XMLPortParam(GUISheet, "backgroundImage",  setBackgroundImage,  getBackgroundImage,  xmlelement, mode);
    6464
    6565        if (this->bShowOnLoad_)
  • code/branches/doc/src/orxonox/overlays/GUISheet.h

    r6746 r7297  
    4444        ~GUISheet();
    4545
    46         void XMLPort(Element& xmlElement, XMLPort::Mode mode);
     46        void XMLPort(Element& xmlelement, XMLPort::Mode mode);
    4747
    4848        void show();
  • code/branches/doc/src/orxonox/overlays/InGameConsole.cc

    r7284 r7297  
    454454    /**
    455455        @brief Prints string to bottom line.
    456         @param s String to be printed
     456        @param text The string to be printed
     457        @param type The type of the text, defines the color
     458        @param index The index of the text overlay in which the string will be displayed
     459        @param alwaysShift If true the ohter lines in the console are always shifted by one line
    457460    */
    458461    void InGameConsole::print(const std::string& text, Shell::LineType type, int index, bool alwaysShift)
  • code/branches/doc/src/orxonox/overlays/OrxonoxOverlay.cc

    r7284 r7297  
    126126        BaseObject::XMLPort()
    127127    */
    128     void OrxonoxOverlay::XMLPort(Element& xmlElement, XMLPort::Mode mode)
    129     {
    130         SUPER(OrxonoxOverlay, XMLPort, xmlElement, mode);
    131 
    132         XMLPortParam(OrxonoxOverlay, "size",      setSize,      getSize,      xmlElement, mode);
    133         XMLPortParam(OrxonoxOverlay, "pickpoint", setPickPoint, getPickPoint, xmlElement, mode);
    134         XMLPortParam(OrxonoxOverlay, "position",  setPosition,  getPosition,  xmlElement, mode);
    135         XMLPortParam(OrxonoxOverlay, "rotation",  setRotation,  getRotation,  xmlElement, mode);
    136         XMLPortParam(OrxonoxOverlay, "correctaspect", setAspectCorrection,   getAspectCorrection,   xmlElement, mode);
    137         XMLPortParam(OrxonoxOverlay, "background",    setBackgroundMaterial, getBackgroundMaterial, xmlElement, mode);
     128    void OrxonoxOverlay::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     129    {
     130        SUPER(OrxonoxOverlay, XMLPort, xmlelement, mode);
     131
     132        XMLPortParam(OrxonoxOverlay, "size",      setSize,      getSize,      xmlelement, mode);
     133        XMLPortParam(OrxonoxOverlay, "pickpoint", setPickPoint, getPickPoint, xmlelement, mode);
     134        XMLPortParam(OrxonoxOverlay, "position",  setPosition,  getPosition,  xmlelement, mode);
     135        XMLPortParam(OrxonoxOverlay, "rotation",  setRotation,  getRotation,  xmlelement, mode);
     136        XMLPortParam(OrxonoxOverlay, "correctaspect", setAspectCorrection,   getAspectCorrection,   xmlelement, mode);
     137        XMLPortParam(OrxonoxOverlay, "background",    setBackgroundMaterial, getBackgroundMaterial, xmlelement, mode);
    138138    }
    139139
     
    306306        The name of the overlay defined BaseObject::setName() (usually done with the "name"
    307307        attribute in the xml file).
     308    @param scale
     309        The scaling factor
    308310    */
    309311    /*static*/ void OrxonoxOverlay::scaleOverlay(const std::string& name, float scale)
     
    346348        The name of the overlay defined BaseObject::setName() (usually done with the "name"
    347349        attribute in the xml file).
     350    @param scroll
     351        The relative translation of the overlay
    348352    */
    349353    /*static*/ void OrxonoxOverlay::scrollOverlay(const std::string& name, const Vector2& scroll)
     
    360364        The name of the overlay defined BaseObject::setName() (usually done with the "name"
    361365        attribute in the xml file).
     366    @param angle
     367        The rotation angle in degree
    362368    */
    363369    /*static*/ void OrxonoxOverlay::rotateOverlay(const std::string& name, const Degree& angle)
  • code/branches/doc/src/orxonox/overlays/OrxonoxOverlay.h

    r6753 r7297  
    9090        virtual ~OrxonoxOverlay();
    9191
    92         virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
     92        virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
    9393
    9494        virtual void changedName();
  • code/branches/doc/src/orxonox/overlays/OverlayGroup.cc

    r7284 r7297  
    7171        BaseObject::XMLPort()
    7272    */
    73     void OverlayGroup::XMLPort(Element& xmlElement, XMLPort::Mode mode)
    74     {
    75         SUPER(OverlayGroup, XMLPort, xmlElement, mode);
    76 
    77         XMLPortParam(OverlayGroup, "scale",  setScale,  getScale,  xmlElement, mode);
    78         XMLPortParam(OverlayGroup, "scroll", setScroll, getScroll, xmlElement, mode);
     73    void OverlayGroup::XMLPort(Element& xmlelement, XMLPort::Mode mode)
     74    {
     75        SUPER(OverlayGroup, XMLPort, xmlelement, mode);
     76
     77        XMLPortParam(OverlayGroup, "scale",  setScale,  getScale,  xmlelement, mode);
     78        XMLPortParam(OverlayGroup, "scroll", setScroll, getScroll, xmlelement, mode);
    7979        // loads all the child elements
    80         XMLPortObject(OverlayGroup, OrxonoxOverlay, "", addElement, getElement, xmlElement, mode);
     80        XMLPortObject(OverlayGroup, OrxonoxOverlay, "", addElement, getElement, xmlelement, mode);
    8181    }
    8282
     
    114114    @brief
    115115        Removes an element from the map.
    116     @param name
    117         The name of the element that is removed.
     116    @param element
     117        A pointer to the element that is removed.
    118118    @return
    119119        Returns true if there was such an element to remove, false if not.
     
    181181        The name of the group defined BaseObject::setName() (usually done with the "name"
    182182        attribute in the xml file).
     183    @param scale
     184        The scaling factor
    183185    */
    184186    /*static*/ void OverlayGroup::scaleGroup(const std::string& name, float scale)
     
    197199        The name of the group defined BaseObject::setName() (usually done with the "name"
    198200        attribute in the xml file).
     201    @param scroll
     202        The relative translation of the overlay group
    199203    */
    200204    /*static*/ void OverlayGroup::scrollGroup(const std::string& name, const Vector2& scroll)
  • code/branches/doc/src/orxonox/overlays/OverlayGroup.h

    r6054 r7297  
    5858        ~OverlayGroup();
    5959
    60         virtual void XMLPort(Element& xmlElement, XMLPort::Mode mode);
     60        virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
    6161
    6262        static void toggleVisibility(const std::string& name);
  • code/branches/doc/src/orxonox/worldentities/WorldEntity.cc

    r7292 r7297  
    650650    @brief
    651651        Translates this WorldEntity by a vector.
     652    @param distance
     653        The relative distance of the translation
    652654    @param relativeTo
    653         @see WorldEntity::TransformSpace
     655        The TransformSpace of this translation
    654656    */
    655657    void WorldEntity::translate(const Vector3& distance, TransformSpace relativeTo)
     
    678680    @brief
    679681        Rotates this WorldEntity by a quaternion.
     682    @param rotation
     683        The desired relative rotation
    680684    @param relativeTo
    681         @see WorldEntity::TransformSpace
     685        The TransformSpace of this translation
    682686    */
    683687    void WorldEntity::rotate(const Quaternion& rotation, TransformSpace relativeTo)
     
    703707    @brief
    704708        Makes this WorldEntity look at a specific target location.
     709    @param target
     710        An absolute point in the space which defines the direction of the entity
    705711    @param relativeTo
    706         @see WorldEntity::TransformSpace
     712        The TransformSpace of this translation
    707713    @param localDirectionVector
    708714        The vector which normally describes the natural direction of the object, usually -Z.
     
    729735    @brief
    730736        Makes this WorldEntity look in specific direction.
     737    @param direction
     738        A point relative to the position of the WorldEntity which defines its orientation
    731739    @param relativeTo
    732         @see WorldEntity::TransformSpace
     740        The TransformSpace of this translation
    733741    @param localDirectionVector
    734742        The vector which normally describes the natural direction of the object, usually -Z.
     
    773781    /**
    774782    @brief
    775         Sets the CollisionType. This alters the object significantly! @see CollisionType.
     783        Sets the CollisionType. This alters the object significantly!
    776784    @note
    777785        Operation does not work on attached WorldEntities.
Note: See TracChangeset for help on using the changeset viewer.