From 1591829b5da321c9971020e89288b8ee96809488 Mon Sep 17 00:00:00 2001 From: Charles Dang Date: Sun, 8 Mar 2015 02:48:35 +1100 Subject: [PATCH] Cleaned up show_story documentation --- src/storyscreen/interface.hpp | 19 ++++--------------- 1 file changed, 4 insertions(+), 15 deletions(-) diff --git a/src/storyscreen/interface.hpp b/src/storyscreen/interface.hpp index 6f56477e414e..dfb2766f890b 100644 --- a/src/storyscreen/interface.hpp +++ b/src/storyscreen/interface.hpp @@ -38,21 +38,10 @@ enum START_POSITION { } /* storyscreen namespace */ /** - * Function to show an introduction sequence segment using story WML. - * The WML config data (story_cfg) has a format similar to: - * @code - * [part] - * id='id' - * story='story' - * image='img' - * [/part] - * @endcode - * Where 'id' is a unique identifier, 'story' is text describing the - * storyline,and 'img' is a background image. Each part of the sequence will - * be displayed in turn, with the user able to go to the next part, or skip - * it entirely. - * Return is NEXT if the segment played to the end, BACK if the segment played to the beginning, - * and QUIT if the story was quit + * Shows an introduction sequence using story WML. + * + * Each part of the sequence will be displayed in turn, with the user + * able to go to the next part, previous part, or skip it entirely. */ void show_story(display &disp, const std::string &scenario_name, const config::const_child_itors &story);