From 2acb2f558c4ee018ad30ce6fb6e8412d175b6c46 Mon Sep 17 00:00:00 2001
From: Tobia Tesan
Date: Sat, 8 Feb 2014 13:59:37 +0100
Subject: WINTERMUTE: Add clarification comment in loadSubtitles

---
 engines/wintermute/video/video_subtitler.cpp | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'engines/wintermute/video/video_subtitler.cpp')

diff --git a/engines/wintermute/video/video_subtitler.cpp b/engines/wintermute/video/video_subtitler.cpp
index a8ce86853a..cc46ddf526 100644
--- a/engines/wintermute/video/video_subtitler.cpp
+++ b/engines/wintermute/video/video_subtitler.cpp
@@ -66,6 +66,13 @@ bool VideoSubtitler::loadSubtitles(const Common::String &filename, const Common:
 
 	Common::String newFile;
 
+	/*
+	 * Okay, the expected behaviour is this: either we are
+	 * provided with a subtitle file to use by the script when
+	 * calling PlayTheora(), or we try to autodetect a suitable
+	 * one which, for /some/path/movie/ogg is to be called
+	 * /some/path/movie.sub
+	 */
 	if (subtitleFile.size() != 0) {
 		newFile = Common::String(subtitleFile);
 	} else {
-- 
cgit v1.2.3