projects
/
supertux.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (from parent 1:
fb07068
)
Added doxygen comments to core game code.
author
Christoph Sommer
<mail@christoph-sommer.de>
Wed, 26 Dec 2007 01:54:49 +0000
(
01:54
+0000)
committer
Christoph Sommer
<mail@christoph-sommer.de>
Wed, 26 Dec 2007 01:54:49 +0000
(
01:54
+0000)
SVN-Revision: 5235
12 files changed:
src/badguy/badguy.hpp
patch
|
blob
|
history
src/badguy/walking_badguy.hpp
patch
|
blob
|
history
src/game_object.hpp
patch
|
blob
|
history
src/game_session.hpp
patch
|
blob
|
history
src/level.hpp
patch
|
blob
|
history
src/mainloop.hpp
patch
|
blob
|
history
src/screen.hpp
patch
|
blob
|
history
src/screen_fade.hpp
patch
|
blob
|
history
src/sector.hpp
patch
|
blob
|
history
src/textscroller.hpp
patch
|
blob
|
history
src/title.hpp
patch
|
blob
|
history
src/worldmap/worldmap.hpp
patch
|
blob
|
history
diff --git
a/src/badguy/badguy.hpp
b/src/badguy/badguy.hpp
index
6c18166
..
e446133
100644
(file)
--- a/
src/badguy/badguy.hpp
+++ b/
src/badguy/badguy.hpp
@@
-38,6
+38,9
@@
#include "audio/sound_manager.hpp"
#include "audio/sound_source.hpp"
#include "audio/sound_manager.hpp"
#include "audio/sound_source.hpp"
+/**
+ * Base class for moving sprites that can hurt the Player.
+ */
class BadGuy : public MovingSprite, protected UsesPhysic, public Serializable
{
public:
class BadGuy : public MovingSprite, protected UsesPhysic, public Serializable
{
public:
diff --git
a/src/badguy/walking_badguy.hpp
b/src/badguy/walking_badguy.hpp
index
5d85039
..
3200cb7
100644
(file)
--- a/
src/badguy/walking_badguy.hpp
+++ b/
src/badguy/walking_badguy.hpp
@@
-25,7
+25,7
@@
class Timer;
/**
class Timer;
/**
- * Base
class for a Badguy that just walks around
.
+ * Base
class for Badguys that walk on the floor
.
*/
class WalkingBadguy : public BadGuy
{
*/
class WalkingBadguy : public BadGuy
{
diff --git
a/src/game_object.hpp
b/src/game_object.hpp
index
5acc833
..
7c4b59f
100644
(file)
--- a/
src/game_object.hpp
+++ b/
src/game_object.hpp
@@
-26,8
+26,10
@@
class DrawingContext;
class ObjectRemoveListener;
/**
class ObjectRemoveListener;
/**
- * This is a base class for all game objects. Each sector of a level will hold a
- * list of active GameObject while the game is played.
+ * Base class for all the things that make up Levels' Sectors.
+ *
+ * Each sector of a level will hold a list of active GameObject while the
+ * game is played.
*
* This class is responsible for:
* - Updating and Drawing the object. This should happen in the update() and
*
* This class is responsible for:
* - Updating and Drawing the object. This should happen in the update() and
diff --git
a/src/game_session.hpp
b/src/game_session.hpp
index
fdb8f4f
..
028aa0c
100644
(file)
--- a/
src/game_session.hpp
+++ b/
src/game_session.hpp
@@
-35,8
+35,7
@@
class CodeController;
class Menu;
/**
class Menu;
/**
- * The GameSession class controlls the controll flow of the Game (the part
- * where you actually play a level)
+ * Screen that runs a Level, where Players run and jump through Sectors.
*/
class GameSession : public Screen
{
*/
class GameSession : public Screen
{
diff --git
a/src/level.hpp
b/src/level.hpp
index
da2fdf4
..
eb3ba5c
100644
(file)
--- a/
src/level.hpp
+++ b/
src/level.hpp
@@
-30,6
+30,11
@@
namespace lisp {
class Lisp;
}
class Lisp;
}
+/**
+ * Represents a collection of Sectors running in a single GameSession.
+ *
+ * Each Sector in turn contains GameObjects, e.g. Badguys and Players.
+ */
class Level
{
public:
class Level
{
public:
diff --git
a/src/mainloop.hpp
b/src/mainloop.hpp
index
bd03372
..
6edb421
100644
(file)
--- a/
src/mainloop.hpp
+++ b/
src/mainloop.hpp
@@
-28,6
+28,9
@@
class Console;
class ScreenFade;
class DrawingContext;
class ScreenFade;
class DrawingContext;
+/**
+ * Manages, updates and draws all Screens, Controllers, Menus and the Console.
+ */
class MainLoop
{
public:
class MainLoop
{
public:
diff --git
a/src/screen.hpp
b/src/screen.hpp
index
a2b753c
..
ae07d59
100644
(file)
--- a/
src/screen.hpp
+++ b/
src/screen.hpp
@@
-21,6
+21,12
@@
class DrawingContext;
class DrawingContext;
+/**
+ * Abstract base class for code the MainLoop runs exclusively and full-screen.
+ *
+ * Examples of Screens are: The TitleScreen, a WorldMap, a level's
+ * GameSession, a TextScroller, ...
+ */
class Screen
{
public:
class Screen
{
public:
diff --git
a/src/screen_fade.hpp
b/src/screen_fade.hpp
index
952d034
..
38dbd62
100644
(file)
--- a/
src/screen_fade.hpp
+++ b/
src/screen_fade.hpp
@@
-22,8
+22,9
@@
#include "screen.hpp"
/**
#include "screen.hpp"
/**
- * A ScreenFade screen is displayed simultaneously with another screen. This
- * is intended to be used for transitional effects like fade-out or shrink-fade
+ * Screen to be displayed simultaneously with another Screen.
+ *
+ * This is used for Screen transition effects like a fade-out or a shrink-fade
*/
class ScreenFade : public Screen
{
*/
class ScreenFade : public Screen
{
diff --git
a/src/sector.hpp
b/src/sector.hpp
index
76a1fa5
..
5033959
100644
(file)
--- a/
src/sector.hpp
+++ b/
src/sector.hpp
@@
-60,8
+60,9
@@
enum MusicType {
};
/**
};
/**
- * This class holds a sector (a part of a level) and all the game objects in
- * the sector
+ * Represents one of (potentially) multiple, separate parts of a Level.
+ *
+ * Sectors contain GameObjects, e.g. Badguys and Players.
*/
class Sector : public Scripting::SSector
{
*/
class Sector : public Scripting::SSector
{
diff --git
a/src/textscroller.hpp
b/src/textscroller.hpp
index
cc166dc
..
a6dafb6
100644
(file)
--- a/
src/textscroller.hpp
+++ b/
src/textscroller.hpp
@@
-78,6
+78,9
@@
private:
Surface* arrow_scrolldown;
};
Surface* arrow_scrolldown;
};
+/**
+ * Screen that displays intro text, extro text, etc.
+ */
class TextScroller : public Screen
{
public:
class TextScroller : public Screen
{
public:
diff --git
a/src/title.hpp
b/src/title.hpp
index
466ec0e
..
5844bec
100644
(file)
--- a/
src/title.hpp
+++ b/
src/title.hpp
@@
-31,6
+31,9
@@
class Menu;
class World;
class CodeController;
class World;
class CodeController;
+/**
+ * Screen that displays the SuperTux logo, lets players start a new game, etc.
+ */
class TitleScreen : public Screen
{
public:
class TitleScreen : public Screen
{
public:
diff --git
a/src/worldmap/worldmap.hpp
b/src/worldmap/worldmap.hpp
index
bfcf960
..
71675ab
100644
(file)
--- a/
src/worldmap/worldmap.hpp
+++ b/
src/worldmap/worldmap.hpp
@@
-65,7
+65,7
@@
Direction string_to_direction(const std::string& d);
Direction reverse_dir(Direction d);
/**
Direction reverse_dir(Direction d);
/**
- * Screen that
displays a worldmap
+ * Screen that
runs a WorldMap, which lets the player choose a Level.
*/
class WorldMap : public Screen
{
*/
class WorldMap : public Screen
{