[Scummvm-cvs-logs] scummvm master -> c1b68a7fd75fb30bcbc26b1a59be526bda877b0c
fingolfin
max at quendi.de
Mon Jun 6 17:58:14 CEST 2011
This automated email contains information about 1 new commit which have been
pushed to the 'scummvm' repo located at https://github.com/scummvm/scummvm .
Summary:
c1b68a7fd7 COMMON: Clarify & correct OSystem::displayLogFile() docs
Commit: c1b68a7fd75fb30bcbc26b1a59be526bda877b0c
https://github.com/scummvm/scummvm/commit/c1b68a7fd75fb30bcbc26b1a59be526bda877b0c
Author: Max Horn (max at quendi.de)
Date: 2011-06-06T08:56:36-07:00
Commit Message:
COMMON: Clarify & correct OSystem::displayLogFile() docs
Changed paths:
common/system.h
diff --git a/common/system.h b/common/system.h
index 87e74d9..f206f4d 100644
--- a/common/system.h
+++ b/common/system.h
@@ -1072,7 +1072,7 @@ public:
* On a desktop operating system, this would typically launch
* some kind of (external) text editor / viewer.
* On a phone, it might also cause a context switch to another
- * application. Finally, on some ports, it might not be supported.
+ * application. Finally, on some ports, it might not be supported
* at all, and so do nothing.
*
* The kFeatureDisplayLogFile feature flag can be used to
@@ -1083,7 +1083,11 @@ public:
*
* @note An error could mean that the log file did not exist,
* or the editor could not launch. However, a return value of true does
- * not guarantee that the user actually will the log file.
+ * not guarantee that the user actually will see the log file.
+ *
+ * @note It is up to the backend to ensure that the system is in a state
+ * that allows the user to actually see the displayed log files. This
+ * might for example require leaving fullscreen mode.
*/
virtual bool displayLogFile() { return false; }
More information about the Scummvm-git-logs
mailing list