Author: shadowmaster
Date: Wed Apr 29 15:33:16 2009
New Revision: 35317
URL: http://svn.gna.org/viewcvs/wesnoth?rev=35317&view=rev
Log:
Doxygen.
Modified:
trunk/src/storyscreen/part.hpp
Modified: trunk/src/storyscreen/part.hpp
URL:
http://svn.gna.org/viewcvs/wesnoth/trunk/src/storyscreen/part.hpp?rev=35317&r1=35316&r2=35317&view=diff
==============================================================================
--- trunk/src/storyscreen/part.hpp (original)
+++ trunk/src/storyscreen/part.hpp Wed Apr 29 15:33:16 2009
@@ -85,18 +85,33 @@
class part
{
public:
+ /**
+ * Where the text block should be placed.
+ * Note that it will always take as much space as it is
+ * possible horizontally.
+ */
enum TEXT_BLOCK_LOCATION {
- TOP,
- MIDDLE,
- BOTTOM
+ TOP, /**< Top of the screen. */
+ MIDDLE, /**< Center of the screen. */
+ BOTTOM /**< Bottom of the screen. This is the default.
*/
};
+ /**
+ * Where the page title should be placed.
+ * It always takes as little space (horizontally) as possible,
+ * and it is always placed at the top of the screen.
+ */
enum TITLE_ALIGNMENT {
- LEFT, CENTERED, RIGHT
+ LEFT, /**< Top-left corner. */
+ CENTERED, /**< Center on the topmost edge of the screen.
*/
+ RIGHT /**< Top-right corner. */
};
+ /**
+ * Used to signal user actions.
+ */
enum RESULT {
- NEXT,
- SKIP,
- QUIT
+ NEXT, /**< Jump to next story part. */
+ SKIP, /**< Skip all story parts for this set. */
+ QUIT /**< Quit game and go back to main menu. */
};
part(game_state& state_of_game, const vconfig& part_cfg);
_______________________________________________
Wesnoth-commits mailing list
[email protected]
https://mail.gna.org/listinfo/wesnoth-commits
