Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Mar 23, 2011, 9:41:21 PM (13 years ago)
Author:
dafrick
Message:

Done documenting Pong.
Also resolved some doxygen warnings.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • code/branches/tetris/src/modules/pong/PongScore.h

    r8106 r8107  
    3939
    4040#include "tools/interfaces/Tickable.h"
     41
    4142#include "overlays/OverlayText.h"
    4243
    … …  
    4546
    4647    /**
    47    
     48    @brief
     49        The PongScore class displays the score for a game of @ref orxonox::Pong "Pong".
     50
     51    @author
     52        Fabian 'x3n' Landau
     53
     54    @ingroup Pong
    4855    */
    4956    class _PongExport PongScore : public OverlayText, public Tickable
    … …  
    5360            virtual ~PongScore();
    5461
    55             virtual void tick(float dt);
     62            virtual void tick(float dt); //!< Creates and sets the caption to be displayed by the PongScore.
    5663            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
    57             virtual void changedOwner();
     64            virtual void changedOwner(); //!< Is called when the owner changes.
    5865
     66            /**
     67            @brief Set whether the PongScore displays the players' names.
     68            @param value If true the players' names are displayed.
     69            */
    5970            inline void setShowName(bool value)
    6071                { this->bShowName_ = value; }
     72            /**
     73            @brief Get whether the PongScore displays the players' names.
     74            @return Returns true if the players' names are displayed, false otherwise.
     75            */
    6176            inline bool getShowName() const
    6277                { return this->bShowName_; }
    6378
     79            /**
     80            @brief Set whether the PongScore displays the players' scores.
     81            @param value If true the players' scores are displayed.
     82            */
    6483            inline void setShowScore(bool value)
    6584                { this->bShowScore_ = value; }
     85            /**
     86            @brief Get whether the PongScore displays the players' scores.
     87            @return Returns true if the players' scores are displayed, false otherwise.
     88            */
    6689            inline bool getShowScore() const
    6790                { return this->bShowScore_; }
    6891
     92            /**
     93            @brief Set whether the PongScore displays the left player.
     94            @param value If true the left player is displayed.
     95            */
    6996            inline void setShowLeftPlayer(bool value)
    7097                { this->bShowLeftPlayer_ = value; }
     98            /**
     99            @brief Get whether the PongScore displays the left player.
     100            @return Returns true if the left player is displayed, false otherwise.
     101            */
    71102            inline bool getShowLeftPlayer() const
    72103                { return this->bShowLeftPlayer_; }
    73104
     105            /**
     106            @brief Set whether the PongScore displays the right player.
     107            @param value If true the right player is displayed.
     108            */
    74109            inline void setShowRightPlayer(bool value)
    75110                { this->bShowRightPlayer_ = value; }
     111            /**
     112            @brief Get whether the PongScore displays the right player.
     113            @return Returns true if the right player is displayed, false otherwise.
     114            */
    76115            inline bool getShowRightPlayer() const
    77116                { return this->bShowRightPlayer_; }
    78117
    79118        private:
    80             Pong* owner_;
    81             bool bShowName_;
    82             bool bShowScore_;
    83             bool bShowLeftPlayer_;
    84             bool bShowRightPlayer_;
     119            Pong* owner_; //!< The Pong game that owns this PongScore.
     120            bool bShowName_; //!< Whether the names of the players are shown.
     121            bool bShowScore_; //!< Whether the score of the players is shown.
     122            bool bShowLeftPlayer_; //!< Whether the left player is shown.
     123            bool bShowRightPlayer_; //!< Whether the right player is shown.
    85124    };
    86125}
Note: See TracChangeset for help on using the changeset viewer.